• Products
  • Documentation
  • Resources

Configure Compass components

This article refers to features that are currently rolling out. To find out when these features will be live on your site, keep an eye on our release notes or the Atlassian Community.

A Compass component represents a piece of software, like a microservice, library, or application. Together, they make up your software architecture and are cataloged for free in Compass, a developer experience tool.

By grouping issues around Compass components, your team can track and reveal the impact of their work on your software architecture; and surface component information that helps move that work forward. Learn more about Compass components

Anyone can create, view, edit, and delete a Compass component. Once it’s created, anyone in any project can link issues to the component; search for the component across those projects; and track the component’s related work and information from a project’s Components page. Learn how to link issues to Compass components

Create a Compass component

A Jira project admin must switch to Compass components.

  1. In your project sidebar, select Components.

  2. Check that Compass components are turned on. Next to Create component, it should say Compass components. If it says Jira components, select it and switch to Compass components.

  3. Select Create component. Compass will open in a new tab.

  4. Fill out the information for the new component.

    1. Choose the component type, which is what it represents in your software architecture. Learn more about component types

    2. Name the component. This is used in an issue’s Components field, or when searching for the component in the project.

    3. Choose an owner team responsible for managing the component. Learn why component owner teams are important

    4. Paste the repository link that represents your component in code. Adding this link will help populate component events and metrics in Compass. Learn more about getting component metrics from an integrated tool

  5. Select Save.

The component will be created in Compass. Now, anyone in the project can start linking issues to the component, and search for it in the backlog, boards, and issue navigator. Learn how to link issues to Compass components

  1. Create a component following the steps above.

  2. Open any issue, and use the Components field to link the issue to the component.

The component will appear on the project’s Components page, along with information to help you manage and progress your work.

Remove the component from every issue’s Components field. The fastest way to do this is to edit multiple issues at the same time.

Once you do this, the component will also disappear from the project’s Components page – because it’s no longer linked to any issues in that project.

Edit a Compass component

  1. In your project sidebar, select Components.

  2. Find the component you want to edit and select its name. Compass will open in a new tab.

  3. Edit any component information you need to. If any of that information appears in Jira Software, it will be updated too.

Delete a Compass component

If you take these steps, the component will be deleted from Compass, and any Jira Software projects and issues it was previously linked to. For a less invasive option, unlink a Compass component from a project.

  1. In your project sidebar, select Components.

  2. Find the component you want to delete and select its name. Compass will open in a new tab.

  3. On the component’s Overview page, select More actions > Delete.

Limitations

Compass components aren’t yet supported in Jira automation. We’re working on it!

Additional Help