GitLab is a web-based Git repository that provides free open and private repositories, issue-following capabilities, and wikis. Compass supports GitLab SaaS but not self-managed.
Compass currently supports GitLab SaaS as a tool to:
import components from GitLab projects to track them in Compass
automate component management from an external tool with config-as-code
sync component data, such as deployment activity, from GitLab to Compass
only GitLab.com SaaS/cloud hosted instances are supported, we do not currently support self-managed GitLab instances
Components are software artifacts such as services, applications, and libraries. They usually live in repositories in source code management tools, such as GitLab. You can create a catalog listing of these components in Compass by importing them from their GitLab repositories.
The process to import component from GitLab repositories involves:
integrating Compass with GitLab Cloud
selecting the repositories to import
We’ll show you how to import components from GitLab 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.
In Compass, select Create from the top navigation bar.
Select Import components, then select Configure in front of the GitLab option.
If you haven’t installed GitLab yet, you’ll see the Install in front of the GitLab option instead. Select it to complete the GitLab app installation first, then come back here.
Update GitLab permissions for Compass, if you’re prompted to do so.
Select Select repositories in the Import components section.
Select repositories containing the components you want to import into Compass.
The Status column shows you whether a repository is available for import.
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.
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.
Select Done.
Once the import completes, search and view your component in Compass.
If you disconnect your GitLab account from Compass, any components managed with config-as-code disconnect from their repositories and no longer sync with GitLab. But don’t worry, the catalog entries of the components you imported earlier remain intact and you can manage them in Compass.