Github

​

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

​

Navigate to GitHub Connections

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 Personal Access Token.

​

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.