SEI GitHub Cloud integration

info

The 202401.2 release included a new experience for the GitHub integration, focused on simplifying and streamlining the user journey. The feature is currently in BETA. To learn more, go to GitHub 2.0

GitHub provides hosting for software development and version control using Git.

Use the SEI GitHub integration to integrate SEI with GitHub.

Personal and organization repositories

SEI only ingests repositories from organizations. SEI doesn't ingest your personal repos or repos where you are a collaborator but not a member of the affiliated organization.

In other words, the owner of the GitHub personal access token that is associated with the integration must be a direct member of an organization for a repo to be ingested by SEI.

Configure authentication

The SEI GitHub integration can use either OAuth or Personal Access Token authentication.

If you can't use OAuth, you must create a GitHub PAT to configure the SEI GitHub integration.

1. Log in to your GitHub account and create a Personal Access Token. For instructions, go to the GitHub documentation on Managing your personal access tokens.

2. Select the following permissions for your personal access token:

   • All repo scopes, including the parent repo scope. The top-level repo scope is required for SEI to have the required visibility into your repos.

   

   • The read:org scope under admin:org.

   

3. Copy the token somewhere that you can retrieve it when you configure the integration.

4. If your GitHub organization uses SAML SSO, enable SSO for your personal access token. For instructions, go to the GitHub documentation on Authorizing a personal access token for use with SAML SSO.

Configure the integration

Cloud

1. In your Harness Project, go to the SEI Module, and select Account.

2. Select Integrations under Data Settings.

3. Select Available Integrations, locate the GitHub Enterprise or GitHub Cloud integration, depending on your GitHub configuration.

4. Select Install.

5. Select an authentication method for the integration:

   • To use OAuth, select Authorize and follow the prompts to grant access to GitHub.
   • To use a personal access token, paste the token in Enter the Access Token.

6. In Integration Name, enter a name for the integration.

7. Select repositories to associate with the integration or select Ingest All Repos to associate all current and future repos in your GitHub organization.

8. If applicable, configure Additional Options:

   • Fetch PRs: Allow SEI to ingest PR data from GitHub.
   • Fetch Issues: Allow SEI to ingest data from GitHub Issues.
   • Fetch Projects: Allow SEI to ingest data from GitHub Projects.
   • Fetch Commits: Allow SEI to ingest commit metadata from GitHub.
   • Fetch Commit Files: Allow SEI to ingest data within commits from GitHub.

9. Finish configuration and Save the integration.

Issue Cycle Time webhook

If you created a personal access token and allowed the admin:org_hook permission, SEI creates a user webhook to receive issue cycle time data for the SCM Issue Time Across Stages Report.

If you used OAuth, SEI creates an organization webhook instead.

Satellite

The steps for configuring the integration using Satellite is similar to configuring the integration on cloud, with the exception of using satellite to communicate with the Github Server.

Make sure to select the satellite integration checkbox while configuring the integration. If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.

Here’s a sample satellite.yml file:

satellite:
  tenant: <ACCOUNT_ID>
  api_key: <ACCOUNT_API_KEY>
  url: 'https://app.harness.io/gratis/sei/api' # Note that this URL is relative to the Environment of your Harness Account.
integrations:
  - id: '<INTEGRATION_ID>'
    application: github
    url: '<GITHUB_INSTANCE_URL>'
    metadata:
      fetch_prs: true
      fetch_issues: true
      fetch_commits: true
      fetch_commit_files: true
      is_push_based: true
      fetch_projects: true
    authentication: multiple_api_keys
    keys:
      - apikey: <GITHUB_PAT>