Skip to main content

​
Overview

The GitHub integration in the Engineering Metrics Dashboard allows organizations to connect GitHub repositories and collect repository activity data for engineering analytics. Using this integration, organizations can monitor:
  • Pull request activity
  • Repository contributions
  • Commit activity
  • Development trends
  • Engineering performance metrics
The GitHub integration supports both GitHub Cloud and GitHub Server environments.

​
Prerequisites

Before configuring the integration, ensure you have:
  • Access to the Engineering Metrics Dashboard
  • A valid GitHub Personal Access Token
  • Access to the GitHub repositories that need to be monitored
  • Required permissions to configure integrations
  1. Open the Engineering Metrics Dashboard.
  2. Navigate to the Integrations section.
  3. Select Source Code Management Integrations.
  4. Choose GitHub from the available integrations.

​
Create a New GitHub Connection

  1. Click New Connection.
  2. The Manage Connections: GitHub window will appear.
  3. Enter a unique Connection Name.

​
Example Connection Names

  • GitHub Production
  • Engineering Repositories
  • GitHub Enterprise

​
Select the GitHub Environment

Choose the GitHub environment that you want to connect.

​
Available Options

​
GitHub Cloud

Select this option when connecting repositories hosted on GitHub.com.

​
GitHub Server

Select this option when connecting repositories hosted on a self managed GitHub Enterprise Server.

​
Configure Authentication

  1. Select the preferred authentication method.
  2. Enter the required classic Personal Access Token.
The Personal Access Token must be a classic token, and must have sufficient scopes to access the repositories that will be synchronized.

​
Create a GitHub Personal Access Token

Follow these steps to create a classic Personal Access Token (PAT) in GitHub. G360 reads the granted scopes back from a classic token to validate it; GitHub’s newer fine grained tokens do not report scopes in a way G360 can verify, so they are not supported for this integration.

​
Step 1: Sign in to GitHub

  1. Sign in to your GitHub account.

​
Step 2: Open Developer Settings

  1. Click your profile picture in the top right corner.
  2. Select Settings.
  3. Scroll to the bottom of the left sidebar.
  4. Click Developer settings.

​
Step 3: Open Personal Access Tokens

  1. Click Personal access tokens.
  2. Select Tokens (classic).

​
Step 4: Generate a New Token

  1. Click Generate new token, then Generate new token (classic).
  2. Complete authentication if prompted.

​
Step 5: Configure the Token

Provide the following details:
  • Note; enter a descriptive name for the token (for example, G360 Integration).
  • Expiration; set the longest expiration your organization’s policy allows. Select No expiration if permitted, so scheduled syncs do not silently start failing later. If your policy forbids a non expiring token, choose the maximum allowed and note the expiry date so the connection can be renewed before it lapses.
Classic tokens are scoped to your account’s own access, not to a specific resource owner or repository list chosen during creation; which organizations and repositories the token can reach depends on your account’s own permissions, and, if the organization enforces SAML SSO, on the authorization step in Step 9 below.

​
Step 6: Select Scopes

Under Select scopes, check the following:
  • repo (or public_repo if you only need access to public repositories)
  • read:org
  • read:user

​
Minimum required token scopes:

When creating a GitHub connection, the access token must include the required scopes based on the repositories you want to access. When creating your GitHub classic Personal Access Token, in Step 6 above, select the following scopes:
Broader scopes are accepted where they imply these; write:org and admin:org satisfy read:org, and user satisfies read:user.
To collect data from private repositories, include all required public repository scopes and enable the following additional scope:
The repo scope is required only if you want to collect data from private repositories. If you only need access to public repositories, the public repository scopes are sufficient.

​
Step 7: Generate the Token

  1. Scroll to the bottom of the page.
  2. Click Generate token.

​
Step 8: Copy the Token

GitHub displays the Personal Access Token only once. Copy it immediately and store it securely, as it cannot be viewed again.

​
Step 9: Use the Token

Copy the generated token into the GitHub integration configuration in G360 to complete the connection.
If your organization enforces SAML SSO, the token is not finished when it is generated. On the token list, click Configure SSO next to the new token and authorize it for every organization in scope. Without this step, the token still authenticates and the connection test still succeeds, but every organization call returns 404 and no repositories will appear.

​
Best Practices

  • Use a classic Personal Access Token; G360 cannot validate fine grained tokens, so they should not be used for this integration.
  • Grant only the minimum permissions required for the integration.
  • Set an expiration date in accordance with your organization’s security policy.
  • Store the token securely and never commit it to source control or share it publicly.
  • Have the org name(s) to sync ready, along with the API base URL if connecting GitHub Enterprise Server, in the format https://<gheshost>/api/v3/.

​
Optional Configuration

​
Proxy

If your organization uses a proxy server, enter the proxy details in the Proxy field.

​
Custom Rate Limit

Users can configure a custom API rate limit if required by organizational policies or GitHub API usage restrictions.

​
Test the Connection

  1. Click Test Connection.
  2. Wait for the validation process to complete.

​
Expected Result

  • If the credentials are valid, the connection test will succeed.
  • If the test fails, verify the Personal Access Token and configuration settings before retrying.

​
Save the Connection

  1. After a successful connection test, click Save Connection.
  2. The GitHub connection will now appear in the available connections list.

​
Configure Data Scopes

After creating the connection:
  1. Select the GitHub connection.
  2. Click Add Data Scope.
The Add Data Scope window allows users to select repositories that should be synchronized with the platform.

​
Repository Selection

  1. Search for the desired repository.
  2. Select one or more repositories using the available checkboxes.
  3. Click Save.
The selected repositories will be added as data scopes for the GitHub connection.

​
Managing Data Scopes

Users can:
  • Add Data Scope
  • Associate Scope Entity
  • Delete Data Scope
These options allow administrators to manage which repositories are included in data collection and reporting.

​
Understanding Data Scopes

A data scope represents a GitHub repository that has been authorized for synchronization. Only repositories included in a configured data scope will be available for project setup and analytics.

​
Using GitHub Data in Projects

After configuring a GitHub connection and data scope:
  1. Navigate to the Projects section.
  2. Create a new project or edit an existing project.
  3. Select GitHub as the data source.
  4. Choose the configured GitHub connection.
  5. Select the required repository scope.
  6. Complete the project configuration.
Once configured, Engineering Metrics will begin collecting repository data from GitHub.

​
Monitoring Synchronization Status

The Status section provides:
  • Synchronization history
  • Task execution details
  • Success and failure status
  • Processing duration
  • Completed operations overview
This helps users monitor synchronization health and activity.

​
Troubleshooting

​
Connection Test Failed

Possible causes:
  • Invalid Personal Access Token
  • Missing repository permissions
  • Incorrect GitHub configuration
  • Network connectivity issues
Recommended actions:
  • Verify the Personal Access Token
  • Confirm repository access permissions
  • Retry the connection test

​
Repositories Not Appearing

Possible causes:
  • Repository access restrictions
  • Missing permissions
  • Synchronization still in progress
Recommended actions:
  • Verify repository visibility
  • Confirm token permissions
  • Retry synchronization

​
Best Practices

  • Use descriptive connection names
  • Verify Personal Access Token validity periodically
  • Only add repositories that are required for reporting
  • Monitor synchronization status regularly
  • Review repository activity and engineering metrics periodically

​
Summary

The GitHub integration enables organizations to connect GitHub repositories directly to the Engineering Metrics Dashboard. By configuring a GitHub connection, selecting repository scopes, and synchronizing repository activity, teams can gain visibility into development trends, pull request activity, repository contributions, and engineering performance metrics.