Manage component Jira integrations

2 minute read

Configure Jira integrations at the component level to link work items (such as tickets and user stories) to component build artifacts for feature traceability. For background on how feature traceability connects work items to artifacts and deployments, refer to Understanding components.

Create a Jira integration

To create a component Jira integration:

  1. Navigate to Components  Integrations.

  2. Select Create integration. The create integration screen displays.

  3. Select the integration type from the dropdown list provided. The fields required to create the integration display.

  4. Enter the required information for the integration type:

    1. Select the appropriate Jira instance from the dropdown list provided. The dropdown displays the list of Jira integrations from the parent organizations.

    2. The domain field is autopopulated based on the Jira integration selected.

    3. Select the purpose of the integration from the dropdown list provided.

    4. Select the appropriate Jira project to associate with this component.

    5. Select the pattern to identify the Jira ticket reference in the commit message. This pattern is used to associate Jira tickets to build artifacts through the commit associated with the build artifact.

    6. Enter the SCM repository branches as a comma-separated list to be considered when associating Jira tickets to build artifacts.

      • If left empty, only commits on the default branch are considered.

      • Branch names can include * as a wildcard. For example, main,release_v considers the main branch and all branches starting with release_v.

  5. Select Save configuration.

Edit a Jira integration

To edit a component Jira integration:

  1. Navigate to Components  Integrations.

  2. Select Vertical ellipsis next to the integration to edit.

  3. Select Edit. The edit integration screen displays.

  4. Edit the required information for the integration type:

    1. Verify or select the appropriate Jira instance from the dropdown list provided. The dropdown displays the list of Jira integrations from the parent organizations.

    2. Verify the domain is correct for the Jira instance selected. Select Manage to manage Jira instances.

    3. Verify or select the purpose of the integration from the dropdown list provided.

    4. Verify or select the appropriate Jira project associated with this component. Select Change project to select a different Jira project.

    5. Verify or select the pattern to identify the Jira ticket reference in the commit message. This pattern is used to associate Jira tickets to build artifacts through the commit associated with the build artifact.

    6. Verify or select the SCM repository branches as a comma-separated list to be considered when associating Jira tickets to build artifacts.

      • If left empty, only commits on the default branch are considered.

      • Branch names can include * as a wildcard. For example, main,release_v considers the main branch and all branches starting with release_v.

  5. Select Save configuration.

Delete a Jira integration

To delete a component Jira integration:

  1. Navigate to Components  Integrations.

  2. Select Vertical ellipsis next to the integration to delete.

  3. Select Delete.

  4. In the confirmation dialog, select Delete to confirm deletion of the integration.