Skip to main content
Feedback

GitHub connection

info

This connector is currently in Early Access. Contact support for details.

GitHub is a cloud-based platform for hosting source code, tracking issues, and running CI/CD workflows. Connect GitHub to Data Integration to sync your repository and organization data for engineering, delivery, and security reporting.

Prerequisite

You need owner-level access to the GitHub organization you want to connect, so that you can generate a personal access token.

Authentication methods

You connect GitHub to Data Integration using a personal access token (fine-grained). Renew the token yourself before it expires.

note

GitHub doesn't support basic authentication (username and password).

Retrieving your credentials from GitHub

Personal access token (fine-grained)

Retrieving a fine-grained personal access token

  1. Sign in to GitHub with the account you want to connect.
  2. Select your profile photo, then select Settings.
  3. In the left sidebar, select Developer settings.
  4. Select Personal access tokens, then Fine-grained tokens.
  5. Select Generate new token. Give it a name and an expiration date.
  6. Under Resource owner, select your organization. Under Repository access, select the repositories you want to sync.
  7. Under Permissions, grant read access to the data you want to sync (for example, Contents, Issues, Pull requests, and Actions).
  8. Select Generate token, then copy the token value immediately. GitHub doesn't show it to you again.
note

Fine-grained tokens expire on the date you set. Renew the token before it expires so your scheduled syncs don't fail.

Connecting GitHub to Data Integration

  1. Navigate to the Data Integration console.
  2. Navigate to Connections and select Create New Connection.
  3. Select GitHub as the connection type.
  4. Enter a Connection Name to identify this connection.
  5. Enter the Personal Access Token you generated.
  6. Select Test Connection to confirm Data Integration can authenticate and reach your GitHub account.
  7. Select Save to finish creating the connection.

Known limitations

  • GitHub limits the number of API requests an account can make per hour. If your organization has a large number of repositories, issues, or workflow runs, syncs might take longer to complete or might run over multiple cycles.
  • Data Integration only syncs data for the organization and repositories you select when you set up your data flow. To add more repositories later, update the data flow's Repositories field.

If you need a report or object that isn't currently supported, contact support so it can be evaluated for a future release.

On this Page