Skip to content

Latest commit

 

History

History
254 lines (212 loc) · 37.1 KB

github.md

File metadata and controls

254 lines (212 loc) · 37.1 KB
Raw

GitHub

This page contains the setup guide and reference information for the GitHub source connector.

Prerequisites

  • Start date
  • GitHub Repositories
  • Branch (Optional)
  • Page size for large streams (Optional)

For Airbyte Cloud:

For Airbyte Open Source:

Setup guide

Step 1: Set up GitHub

Create a GitHub Account.

Airbyte Open Source additional setup steps

Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ,.

Step 2: Set up the GitHub connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select GitHub from the Source type dropdown and enter a name for this connector.
  4. Click Authenticate your GitHub account by selecting Oauth or Personal Access Token for Authentication.
  5. Log in and Authorize to the GitHub account.
  6. Start date - The date from which you'd like to replicate data for streams: comments, commit_comment_reactions, commit_comments, commits, deployments, events, issue_comment_reactions, issue_events, issue_milestones, issue_reactions, issues, project_cards, project_columns, projects, pull_request_comment_reactions, pull_requests, pull_requeststats, releases, review_comments, reviews, stargazers, workflow_runs, workflows.
  7. GitHub Repositories - Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/airbyte airbytehq/another-repo for multiple repositories. If you want to specify the organization to receive data from all its repositories, then you should specify it according to the following example: airbytehq/*. Repositories with the wrong name, or repositories that do not exist, or have the wrong name format are not allowed.
  8. Branch (Optional) - Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled. (e.g. airbytehq/airbyte/master airbytehq/airbyte/my-branch).
  9. Max requests per hour (Optional) - The GitHub API allows for a maximum of 5000 requests per hour (15000 for Github Enterprise). You can specify a lower value to limit your use of the API quota.

For Airbyte Open Source:

  1. Authenticate with Personal Access Token.

Supported sync modes

The GitHub source connector supports the following sync modes:

Feature Supported?
Full Refresh Sync Yes
Incremental - Append Sync Yes
Replicate Incremental Deletes Coming soon
SSL connection Yes
Namespaces No

Supported Streams

This connector outputs the following full refresh streams:

This connector outputs the following incremental streams:

Notes

  1. Only 4 streams (comments, commits, issues and review comments) from the above 24 incremental streams are pure incremental meaning that they:

    • read only new records;
    • output only new records.

  2. Streams workflow_runs and worflow_jobs is almost pure incremental:

    • read new records and some portion of old records (in past 30 days) docs;
    • the workflow_jobs depends on the workflow_runs to read the data, so they both follow the same logic docs;
    • output only new records.

  3. Other 19 incremental streams are also incremental but with one difference, they:

    • read all records;
    • output only new records. Please, consider this behaviour when using those 19 incremental streams because it may affect you API call limits.

  4. We are passing few parameters (since, sort and direction) to GitHub in order to filter records and sometimes for large streams specifying very distant start_date in the past may result in keep on getting error from GitHub instead of records (respective WARN log message will be outputted). In this case Specifying more recent start_date may help. The "Start date" configuration option does not apply to the streams below, because the GitHub API does not include dates which can be used for filtering:

  • assignees
  • branches
  • collaborators
  • issue_labels
  • organizations
  • pull_request_commits
  • pull_request_stats
  • repositories
  • tags
  • teams
  • users

Permissions and scopes

If you use OAuth authentication method, the oauth2.0 application requests the next list of scopes: repo, read:org, read:repo_hook, read:user, read:discussion, workflow. For personal access token it need to manually select needed scopes.

Your token should have at least the repo scope. Depending on which streams you want to sync, the user generating the token needs more permissions:

  • For syncing Collaborators, the user which generates the personal access token must be a collaborator. To become a collaborator, they must be invited by an owner. If there are no collaborators, no records will be synced. Read more about access permissions here.
  • Syncing Teams is only available to authenticated members of a team's organization. Personal user accounts and repositories belonging to them don't have access to Teams features. In this case no records will be synced.
  • To sync the Projects stream, the repository must have the Projects feature enabled.

Performance considerations

The GitHub connector should not run into GitHub API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

Version Date Pull Request Subject
1.0.4 2023-08-03 29031 Reverted advancedAuth spec changes
1.0.3 2023-08-01 28910 Updated advancedAuth broken references
1.0.2 2023-07-11 28144 Add archived_at property to Organizations schema parameter
1.0.1 2023-05-22 25838 Deprecate "page size" input parameter
1.0.0 2023-05-19 25778 Improve repo(s) name validation on UI
0.5.0 2023-05-16 25793 Implement client-side throttling of requests
0.4.11 2023-05-12 26025 Added more transparent depiction of the personal access token expired
0.4.10 2023-05-15 26075 Add more specific error message description for no repos case.
0.4.9 2023-05-01 24523 Add undeclared columns to spec
0.4.8 2023-04-19 00000 Fix repo name validation
0.4.7 2023-03-24 24457 Add validation and transformation for repositories config
0.4.6 2023-03-24 24398 Fix caching for get_starting_point in stream "Commits"
0.4.5 2023-03-23 24417 Add pattern_descriptors to fields with an expected format
0.4.4 2023-03-17 24255 Add field groups and titles to improve display of connector setup form
0.4.3 2023-03-04 22993 Specified date formatting in specification
0.4.2 2023-03-03 23467 added user friendly messages, added AirbyteTracedException config_error, updated SAT
0.4.1 2023-01-27 22039 Set AvailabilityStrategy for streams explicitly to None
0.4.0 2023-01-20 21457 Use GraphQL for issue_reactions stream
0.3.12 2023-01-18 21481 Handle 502 Bad Gateway error with proper log message
0.3.11 2023-01-06 21084 Raise Error if no organizations or repos are available during read
0.3.10 2022-12-15 20523 Revert changes from 0.3.9
0.3.9 2022-12-14 19978 Update CDK dependency; move custom HTTPError handling into AvailabilityStrategy classes
0.3.8 2022-11-10 19299 Fix events and workflow_runs datetimes
0.3.7 2022-10-20 18213 Skip retry on HTTP 200
0.3.6 2022-10-11 17852 Use default behaviour, retry on 429 and all 5XX errors
0.3.5 2022-10-07 17715 Improve 502 handling for comments stream
0.3.4 2022-10-04 17555 Skip repository if got HTTP 500 for WorkflowRuns stream
0.3.3 2022-09-28 17287 Fix problem with "null" cursor_field for WorkflowJobs stream
0.3.2 2022-09-28 17304 Migrate to per-stream state.
0.3.1 2022-09-21 16947 Improve error logging when handling HTTP 500 error
0.3.0 2022-09-09 16534 Add new stream WorkflowJobs
0.2.46 2022-08-17 15730 Validate input organizations and repositories
0.2.45 2022-08-11 15420 "User" object can be "null"
0.2.44 2022-08-01 14795 Use GraphQL for pull_request_comment_reactions stream
0.2.43 2022-07-26 15049 Bugfix schemas for streams deployments, workflow_runs, teams
0.2.42 2022-07-12 14613 Improve schema for stream pull_request_commits added "null"
0.2.41 2022-07-03 14376 Add Retry for GraphQL API Resource limitations
0.2.40 2022-07-01 14338 Revert: "Rename field mergeable to is_mergeable"
0.2.39 2022-06-30 14274 Rename field mergeable to is_mergeable
0.2.38 2022-06-27 13989 Use GraphQL for reviews stream
0.2.37 2022-06-21 13955 Fix "secondary rate limit" not retrying
0.2.36 2022-06-20 13926 Break point added for workflows_runs stream
0.2.35 2022-06-16 13763 Use GraphQL for pull_request_stats stream
0.2.34 2022-06-14 13707 Fix API sorting, fix get_starting_point caching
0.2.33 2022-06-08 13558 Enable caching only for parent streams
0.2.32 2022-06-07 13531 Fix different result from get_starting_point when reading by pages
0.2.31 2022-05-24 13115 Add incremental support for streams WorkflowRuns
0.2.30 2022-05-09 12294 Add incremental support for streams CommitCommentReactions, IssueCommentReactions, IssueReactions, PullRequestCommentReactions, Repositories, Workflows
0.2.29 2022-05-04 12482 Update input configuration copy
0.2.28 2022-04-21 11893 Add new streams TeamMembers, TeamMemberships
0.2.27 2022-04-02 11678 Fix "PAT Credentials" in spec
0.2.26 2022-03-31 11623 Re-factored incremental sync for Reviews stream
0.2.25 2022-03-31 11567 Improve code for better error handling
0.2.24 2022-03-30 9251 Add Streams Workflow and WorkflowRuns
0.2.23 2022-03-17 11212 Improve documentation and spec for Beta
0.2.22 2022-03-10 10878 Fix error handling for unavailable streams with 404 status code
0.2.21 2022-03-04 10749 Add new stream ProjectCards
0.2.20 2022-02-16 10385 Add new stream Deployments, ProjectColumns, PullRequestCommits
0.2.19 2022-02-07 10211 Add human-readable error in case of incorrect organization or repo name
0.2.18 2021-02-09 10193 Add handling secondary rate limits
0.2.17 2021-02-02 9999 Remove BAD_GATEWAY code from backoff_time
0.2.16 2021-02-02 9868 Add log message for streams that are restricted for OAuth. Update oauth scopes.
0.2.15 2021-01-26 9802 Add missing fields for auto_merge in pull request stream
0.2.14 2021-01-21 9664 Add custom pagination size for large streams
0.2.13 2021-01-20 9619 Fix logging for function should_retry
0.2.11 2021-01-17 9492 Remove optional parameter Accept for reaction`s streams to fix error with 502 HTTP status code in response
0.2.10 2021-01-03 7250 Use CDK caching and convert PR-related streams to incremental
0.2.9 2021-12-29 9179 Use default retry delays on server error responses
0.2.8 2021-12-07 8524 Update connector fields title/description
0.2.7 2021-12-06 8518 Add connection retry with GitHub
0.2.6 2021-11-24 8030 Support start date property for PullRequestStats and Reviews streams
0.2.5 2021-11-21 8170 Fix slow check connection for organizations with a lot of repos
0.2.4 2021-11-11 7856 Resolve $ref fields in some stream schemas
0.2.3 2021-10-06 6833 Fix config backward compatability
0.2.2 2021-10-05 6761 Add oauth worflow specification
0.2.1 2021-09-22 6223 Add option to pull commits from user-specified branches
0.2.0 2021-09-19 5898 and 6227 Don't minimize any output fields & add better error handling
0.1.11 2021-09-15 5949 Add caching for all streams
0.1.10 2021-09-09 5860 Add reaction streams
0.1.9 2021-09-02 5788 Handling empty repository, check method using RepositoryStats stream
0.1.8 2021-09-01 5757 Add more streams
0.1.7 2021-08-27 5696 Handle negative backoff values
0.1.6 2021-08-18 5456 Add MultipleTokenAuthenticator
0.1.5 2021-08-18 5456 Fix set up validation
0.1.4 2021-08-13 5136 Support syncing multiple repositories/organizations
0.1.3 2021-08-03 5156 Extended existing schemas with users property for certain streams
0.1.2 2021-07-13 4708 Fix bug with IssueEvents stream and add handling for rate limiting
0.1.1 2021-07-07 4590 Fix schema in the pull_request stream
0.1.0 2021-07-06 4174 New Source: GitHub