Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Source Github: add 3 new streams (workflows, workflow runs and repository vulnerability) #9251

Merged
merged 27 commits into from
Mar 30, 2022

Conversation

bzAmin
Copy link
Contributor

@bzAmin bzAmin commented Jan 3, 2022

…eam for the connector asana

What

Describe what the change is solving
For 2 connectors GitHub and asana
GitHub : Adding 3 streams Workflows, Workflow runs and vulnerability alert
Asana : We collect all the stories of a task but we don't have the task id. Added in the parse_response.

How

Create 3 new streams for the GitHub source.
Add a parse response for the Asana stream "stories" to add the task_id

Recommended reading order

  1. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.
Not impactful for the users

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.


This change is Reviewable

@CLAassistant
Copy link

CLAassistant commented Jan 3, 2022

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/connectors Connector related issues label Jan 3, 2022
@marcosmarxm
Copy link
Member

marcosmarxm commented Jan 3, 2022

@bzAmin thanks for the contribution, can you sign the CLA?

@marcosmarxm
Copy link
Member

@bzAmin can you run ./gradlew format and bump the connectors version for Asana and Github? see here

return "POST"

def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
return f"graphql"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the f-string.


# Security streams

class Security(GithubStream):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a more meaningful name like RepositoryVulnerabilityAlert

@marcosmarxm marcosmarxm self-assigned this Jan 4, 2022
@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 4, 2022

Hello ! I performed the changes. I'm waiting the review to perform the third step in the documentation publishing a connector :

One of Airbyte maintainers will review the change and publish the new version of the connector to Docker hub. Triggering tests and publishing connectors can be done by leaving a comment on the PR with the following format (the PR must be from the Airbyte repo, not a fork):

@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 4, 2022

concerning the ./gradlew format : I ran ./gradlew :airbyte-integrations:connectors:source-github:build. Is it what you meant?
Thanks for your review.

image

@marcosmarxm
Copy link
Member

concerning the ./gradlew format : I ran ./gradlew :airbyte-integrations:connectors:source-github:build. Is it what you meant? Thanks for your review.

image

yes, thanks @bzAmin
also can you sign the CLA?
image

@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 4, 2022

Hello @marcosmarxm ! Done the CLA has been signed.

@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 11, 2022

Hello, any news on this pull request ? thanks for your review.

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments, sorry the delay @bzAmin !!!

@github-actions github-actions bot added area/api Related to the api area/documentation Improvements or additions to documentation area/frontend area/platform issues related to the platform area/protocol area/scheduler area/server area/worker Related to worker CDK Connector Development Kit labels Jan 19, 2022
@bzAmin bzAmin changed the title 3 new streams to the github api and adding task_id in the stories str… 3 new streams to the github api Jan 19, 2022
@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 19, 2022

Hello @marcosmarxm changes has been made. Thanks for your review

@bzAmin bzAmin requested a review from marcosmarxm January 20, 2022 09:57
@marcosmarxm marcosmarxm changed the title 3 new streams to the github api Source Github: add 3 new streams (workflows, workflow runs and repository vulnerability) Jan 25, 2022
@bzAmin
Copy link
Contributor Author

bzAmin commented Jan 26, 2022

Hello @marcosmarxm, thanks for your code approval. Can you please approve the workflow?

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Mar 30, 2022
@marcosmarxm
Copy link
Member

sorry the delay I need to remove the vulnerability report, feel free to submit another PR adding that stream.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants