Last updated Jun 18, 2024

Import components from 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

Components are software artifacts such as services, applications, and libraries. They usually live in repositories in source code management tools, such as GitHub. You can create a catalog listing of these components in Compass by importing them from their GitHub repositories.

The process to import component from GitHub repositories involves:

  1. integrating Compass with GitHub Cloud
  2. selecting the repositories to import

We’ll show you how to import components from GitHub repositories.

You can’t import components of the capability, cloud resource, data pipeline, machine learning model, UI element, and website types from a connected app. We're working on adding this feature for components like this.

For now, create the component manually or use the API.

Before you begin

Before you start importing components, integrate Compass with GitHub:

  1. Install the GitHub app in Compass. Select Apps from the top navigation and select Install on GitHub tile.
  2. Select Configure on the GitHub tile and connect Compass to the GitHub organization containing your component’s repositories.

Learn more about integrating Compass with GitHub

Import components from GitHub

  1. In Compass, select Create from the top navigation bar.
  2. Select Import components, then select Configure in front of the GitHub option.
    • If you haven’t installed GitHub yet, you’ll see the Install in front of the GitHub option instead. Select it to complete the GitHub app installation first, then come back here.
  3. Update GitHub permissions for Compass, if you’re prompted to do so.
  4. Select Select repositories in the Import components section.
  5. Select repositories containing the components you want to import into Compass.
    • The Status column shows you whether a repository is available for import.
  6. Select a component type for each component, and proceed to the import step.
    • Select the component type carefully. You won’t be able to change it once the import completes and creates the component’s catalog listing in Compass.
  7. Check the status of your import.
    • You’ll be able to see if any components failed to import. Follow the import process to import those components again.
  8. Select Done.

Once the import completes, search and view your component in Compass.

If you disconnect your GitHub organization from Compass, any components managed with config-as-code disconnect from their repositories and no longer sync with GitHub. But don’t worry, the catalog entries of the components you imported earlier remain intact and you can manage them in Compass.

Rate this page: