Import components from repositories linked to Jira

Create a unified, automated, and detailed catalog of your software architecture using Bitbucket, GitHub, and GitLab repositories linked to Jira.

Compass will find Jira projects that contain repositories you might want to create as software components. As components are created, they’ll include relevant information that encourage teams to use Compass as a source of truth.

After you create these components, take your software catalog further:

• Automatically populate activity and metrics from source code by connecting the Bitbucket, GitHub, or GitLab apps.
• Encourage accountability and improve failing scorecards by assigning owner teams.
• Track and prioritize work against components by linking them to Jira issues.

Before you begin

1. As a site admin, integrate Jira Cloud with Bitbucket, GitHub, or GitLab.

2. As a site or project admin, enable code in Jira.

3. Link repositories to a Jira project.

Import components

1. In Compass, select Create in the main navigation, then Import components.

2. Next to Jira, select Import.

3. Choose recent Jira projects. Bitbucket, GitHub, and GitLab repositories in the projects you choose will be created as Compass components.

   If you don’t see any projects, complete the steps in the before you begin section.

   

4. Select Create.

   Repositories will be created as Compass components, and include the following information:

   • Service type
   • Name (taken from repository name)
   • Description (indicating the component was imported from a specific Jira project)
   • jira-import label
   • Jira project link that the repository came from
   • Repository link

   The import process can take a few minutes.

5. When the import completes, select Go to Compass to see a list of your new components.

   

Next steps

1. Connect the Bitbucket, GitHub, or GitLab app to automatically populate activity and metrics from source code.

2. Assign owner teams to components to encourage accountability and improve failing scorecards.

3. Link Jira issues to components to track and prioritize work against your software architecture.

Troubleshooting

If an import doesn't complete

Sometimes an import may not complete due to network issues. If this happens, try and create the components again.

Compass will prevent components being duplicated by looking at existing component names, descriptions, and labels.

Cancel an import

During the import process, select Stop creating. Depending on when you cancel the import, some repositories may still be created as software components in Compass, which you can delete at any time.