Skip to main content

Show the Jira tab on a component

Each annotated component gets a Jira tab: the open issues of its Jira project, most recently updated first.

Before you start: a Jira integration is added, Data Center or Cloud.

πŸ”› 1. Turn on the plugin​

  1. In Administration, under PLATFORM, click Plugins.
  2. On the Jira card, turn on the Enable Jira switch.

🏷️ 2. Annotate the component​

In the component's catalog-info.yaml, add the key of its Jira project: the prefix of its issue numbers, SHOP for SHOP-42.

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: shop-api
annotations:
jira/project-key: SHOP
spec:
type: service
lifecycle: production
owner: group:default/platform-team

πŸ‘€ 3. Check​

Open the component in Catalog: the Jira tab lists Issue, Summary, Status and Updated.

βœ… That's it!

What it shows, and to whom​

Anyone who can open the component sees its tab. Astrolabe reads Jira with the token of the integration, the same for every reader.

Something is wrong? See Common problems with Jira.