Last updated Sep 26, 2022

Rate this page:

Integrate Compass with GitHub

What is GitHub?

GitHub is a Git-based code hosting and collaboration tool, built for teams.

Compass currently supports GitHub as a tool to:

  • import components from GitHub repositories to track them in Compass
  • automate component management from an external tool with config-as-code
  • sync component data, such as deployment activity, from GitHub to Compass

Integrate Compass with GitHub

To integrate Compass with GitHub, you must first install the GitHub app in Compass. Then, you connect Compass to the Github organization that contains the repositories from where you want to manage the component.

Before you begin

  • Ensure that you’re an owner of the GitHub organization you want to connect to or work with your organization owner to install this GitHub app.
  • Ensure that you’re an admin on your Compass instance.

You can connect only one GitHub organization to a Compass instance.

Perform the integration

To integrate Compass with GitHub:

  1. Select Apps from the top navigation bar in Compass.
  2. Select Install on the GitHub app card. This installs the GitHub app in Compass.
  3. Select Configure on the GitHub app card.
  4. Authorize the GitHub app to access Compass on your behalf if you haven't previously done so.
  5. Select Connect to GitHub.
  6. The Install Atlassian Compass list displays the GitHub organizations that you're a member of. Select an organization to connect with Compass. You must be an owner of the Github organization you choose.
  7. Select Install.

Now you can manage components from the repositories within the connected GitHub organization by setting up configuration as code (config-as-code) for your components. Learn how to manage components via config-as-code

Personal GitHub user accounts can’t be connected to Compass. This app can only be installed for GitHub organizations and enterprise accounts.

Connect GitHub as an event source to components

The GitHub app for Compass collects events to display on the Compass Activity Feed and automatically calculate certain metrics for your components. The following events are collected when you connect a GitHub repository to your component:

To connect a repository to your component:

  1. In GitHub, copy the link to your component’s repository.
  2. Go to your component in Compass.
  3. In the Overview page of your component’s details, add the link in the Repositories section. Learn more about adding links to a component's resources

Events will begin to appear on the activity feed and metrics will begin to calculate on the component details page.

Take a note of these additional points:

  • A component's deployment activity appears in Compass only if you've connected the event source to the component and there has been at least one deployment in your component’s production-type environment within the last 28 days.

  • The activity feed also shows deployment events from a component's upstream dependencies if you've connected event sources to those components (i.e. added a repository link). The deployment events from your component’s dependencies appear alongside the deployment events from your component.

  • You can add links to any repositories from the GitHub Organization connected to your Compass site. The activity feed does not show deployment events from any repositories that are not in the connected GitHub Organization.

  • Build events on the default branch of the repository will not show up on the activity feed but they will be collected and used to calculate certain metrics for your component.

Disconnect the GitHub organization connected with Compass

Compass’s integration with a GitHub organization lets you manage your components with configuration as code (config-as-code) by using GitHub as a component management tool. However, if you want to configure a different workspace or no longer want to use config-as-code, you can disconnect your current GitHub organization from Compass.

Before you begin

  • Ensure that you’re an admin on your Compass instance.

Once you disconnect a GitHub organization, any managed components in Compass are disconnected and will no longer be synced with GitHub. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.

Disconnect the organization

To disconnect a GitHub organization from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the GitHub app card.
  3. Select Disconnect organization on the GitHub app card. The GitHub organization is disconnected from Compass and the page refreshes to its initial state with no organization connected.

Now you can manage the components previously managed via config-as-code from the Compass UI. You can also configure a different GitHub organization.

Uninstall the GitHub app from Compass

If you no longer want to use GitHub as a component management tool, you can uninstall the GitHub app from Compass.

Before you begin

  • Ensure that you’re an admin on your Compass instance.

Once you uninstall the GitHub app, any managed components in Compass are disconnected and will no longer be synced with GitHub. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.

Uninstall the GitHub app

To uninstall the GitHub app from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the GitHub app card.
  3. Select Uninstall on the GitHub app card. The GitHub app uninstalls from Compass.

Now your GitHub-managed components will no longer be managed by any existing compass.yml files and can be modified and updated via the Compass UI. At any time, you can again integrate Compass with GitHub to set up config-as-code for component management.

Supported metrics

Learn more about working with metrics in Compass.

The GitHub app for Compass supports the following metrics:

MetricDescriptionHow it's calculated
Build Success RateThe ratio of build events for this component that were successful compared to all build events (including failed, timed out, etc.). Only the last 25 build events are evaluated.Build events on the default branch.
Build TimeThe average amount of time it took for a build event to finish over the last ten successful build events.Build events on the default branch.
Deployment FrequencyThe weekly average of times a deployment event to production occurred in the previous four weeks.Deployment events from GitHub Actions.
Open Pull RequestsThe count of currently open pull requests for a component.Pull requests for the default branch currently in the open state.
PR Cycle TimeHow long it took on average for a Pull Request to go from ‘open’ to ‘merged’ over the last ten pull requests.Pull request open and close events for the default branch.

GitHub environment name mapping

The GitHub app for Compass evaluates the name of your GitHub Environment for all deployment events and uses a mapping to determine what environment type (Production, Staging, etc.) it falls into. We look for the presence of the below words within the name of the environment to determine the type.

  • production: "production", "prod", "prd", "live"
  • staging: "staging", "stage", "stg", "preprod", "model", "internal"
  • testing: "testing", "test", "tests", "tst", "integration", "integ", "intg", "int", "acceptance", "accept", "acpt", "qa", "qc", "control", "quality", "uat", "sit", "canary"
  • development: "development", "dev", "trunk"

In the case that an environment name matches more than one type, we use the order shown above to determine the mapping. For example, if your environment is named "dev-prod" we would map it to Production.

Import components from GitHub

Once you have finished setting up the integration, you can import your repositories from GitHub into Compass as components. Simply select Create from the top navigation bar in Compass and then choose "Import components" to get started. Learn more about importing from GitHub here.

Rate this page: