Auto-populate your catalog
A comprehensive, reliable, and accurate catalog is essential for maximizing the value of Compass. To help your team get started with a high-quality catalog from day one, Compass automatically populates your catalog data using the integrations you’ve already configured in Jira.
How auto-populating works
When your team connects either the Bitbucket Cloud integration or the GitHub integration to Jira, your repository information is ingested into the Teamwork Graph.
The Teamwork Graph is a powerful data layer that aggregates data from various sources, such as integrations, and unifies that data across all of Atlassian’s platform. The repository data ingested by the Teamwork Graph is then leveraged in Compass to auto-create and auto-populate components and their associated metadata.
Types of auto-populated data
Upon onboarding to Compass, you’ll immediately see the catalog begin to auto-populate. A component is created for each repository that exists in any Bitbucket workspaces or GitHub organizations that you’ve connected to Jira.
Within each of these components, Compass also attempts to auto-populate various metadata based on your repository and other data in the Teamwork Graph. The following metadata fields may be auto-populated:
Description
Owner team
Documentation links (markdown files and API specs from your repository)
Events and Activity
All auto-populated data in a component is marked with the cloud-saved icon.
To view the source of auto-populated data, select the icon, and you will be directed to the Component Log. In this log, you’ll see all auto-population related activity and details.
Start auto-populating your catalog
You can use the catalog while it is auto-populating, but do not manually add new components until it is complete to avoid duplicate components.
Ensure that you have connected Bitbucket Cloud to Jira or have connected GitHub to Jira.
Navigate to Compass from your site’s main navigation: select Switch to, then More Atlassian products.
Once you arrive in Compass, select your role and proceed to your auto-populated catalog.
You can manually add or remove components from your catalog. How to create components
If you disconnect your GitHub organization or Bitbucket workspace from Jira, auto-populated components based on those connections will be deleted.
If you have a large number of repositories in your organization or workspace, your catalog may take longer to auto-populate. If you have over 5,000 repositories, it may take several hours for your catalog to finish auto-populating.
Auto-populated data is only available for new Compass tenants. Existing Compass tenants can't currently use this feature, and are encouraged to import components directly from Jira.
Was this helpful?