Prepare for a GitHub Connection (Beta)

To set up your GitHub repository with Data Cloud, you need to provide some details. Gather this information before you get started.

Select a method for authentication:

  • Personal Access, which requires a user Token and URL
  • GitHub App, which requires an App ID, Private Key, Installation ID, and URL.

In GitHub, follow these instructions to generate a Classic Personal Access Token. You must use a GitHub account that has read and write access to the repository you want to use for connecting to Data Cloud. Ask your GitHub repository maintainer for help if required. Keep in mind:

  • When creating the token, set the expiration date to never expire.
  • When the token appears in the GitHub UI, click the copy button and save this token in a safe location. You need it later.

After generating the token, you can’t see it again. Save it in a secure location. If you need to regenerate the token, you must reconfigure the connector with the new token information. Otherwise, the connector breaks.

Copy the full URL to your repository, for example, https://api.github.com for GitHub.com or https://github.enterprise.com/api/v3 for GitHub Enterprise. Your actual URL can differ depending on your Domain Name System (DNS). Once you’ve located the URL, proceed to Get Your Repository ID.

This step requires you to register a GitHub App under your organization. See these instructions for details.

Locate your GitHub App ID and private key by using the directions for Authenticating as a GitHub App.

Locate your Installation ID by using the directions for Generating an Installation access token.

Copy the full URL to your repository, for example, https://api.github.com for GitHub.com or https://github.enterprise.com/api/v3 for GitHub Enterprise. Your actual URL can differ depending on your DNS.

In the address bar for your repository, the repository ID appears after your user name, for example, https://github.com/GHUser/RepoID. Copy both the GHUser and RepoID. For example: GHUser/RepoID.

Alternatively, using the GraphQL API Explorer, run this command. Replace the owner and repo_name with the actual information: gh api graphql -f query='query{repository(owner: "owner", name: "repo_name"){id}}'

Use labels and milestones to classify and filter your content. When your GitHub connector runs, only specified items are uploaded to Data Cloud. Read more about Managing labels and milestones.

Next Step: