Connecting GitHub

CompassHQ integrates with GitHub to pull repository data, track deployments, and calculate delivery metrics. This guide covers installing the GitHub App and selecting which repositories to monitor.

Prerequisites

Before connecting GitHub, make sure you have:

• A CompassHQ account with Admin permissions.
• Owner or admin access to the GitHub organization you want to connect.

Installing the GitHub App

1. Navigate to Settings > Integrations in CompassHQ.
2. Click Connect GitHub. You will be redirected to GitHub to authorize the CompassHQ App.
3. Select the GitHub organization you want to link. If you belong to multiple organizations, choose the one that contains the repositories you want to track.
4. Choose the repository access level:
   • All repositories — CompassHQ will automatically import current and future repos.
   • Selected repositories — Pick specific repos to import. You can update this selection later.
5. Click Install & Authorize to complete the connection.

After installation, CompassHQ begins syncing repository metadata. The initial sync typically takes one to five minutes depending on the number of repositories.

Permissions Overview

The CompassHQ GitHub App requests the following permissions:

• Repository contents (read) — to analyze commit and branch data.
• Pull requests (read) — to track PR cycle time and review metrics.
• Deployments (read) — to capture deployment events for DORA metrics.
• Organization members (read) — to map contributors to your CompassHQ teams.

CompassHQ does not request write access to your code or repository settings.

Verifying the Connection

Once the App is installed:

1. Return to Settings > Integrations in CompassHQ.
2. Confirm that the GitHub connection shows a Connected status.
3. Navigate to Teams and verify that your repositories appear in the repository list.

If repositories are missing, check that they were included in the access selection on GitHub and that the sync has finished.

Next Steps

With GitHub connected, you are ready to bring your colleagues on board. See Inviting Your Team to add members and assign roles.