Managing flags with Jira

2 minute read

By integrating CloudBees Feature Management feature flags with Jira issues, you can:

  • Quickly determine within CloudBees Feature Management if a Jira issue is completed.

  • View a listing of all Jira issues relevant to a feature rollout in the CloudBees Feature Management UI.

  • Assist in preventing accidental flag configuration updates before all relevant Jira issues are completed.

  • Facilitate deletion of unused flags to maintain cleaner code. Refer to Deleting feature flags for more information.

The following instructions are for Jira integration using a Jira API token. To learn more, refer to Integrating with a Jira API token.

Adding a Jira issue to a flag

To coordinate flag tasks, such as ensuring that you have removed all flag references from the code prior to flag deletion, you can add Jira issues to a flag.

You must first integrate CloudBees Feature Management with Jira using a Jira API token, and each issue must first exist in Jira before it can be added to a flag.

To add an issue from Jira to a flag:

  1. From the CloudBees Feature Management Home page, select Flags in environments, and then select an environment.

  2. Select a flag, and then select the Jira tab.

    The number of Jira issues connected to a flag are listed on the Jira tab.
  3. Select Add Jira issue.

    Adding a Jira issue
    Figure 1. The Jira issue tab and Add Jira issue highlighted
  4. Optionally, create a new Jira issue by selecting Create issue. The Jira website opens in a new browser tab.

    Create a Jira issue
    Figure 2. Create issue highlighted
  5. Search for your Jira issue (newly created or existing) using the exact issue key, or the summary subtext.

  6. Select any number of issues from the search results list.

  7. Select Add selected.

    Search results for a Jira issue
    Figure 3. Search results for an example Jira issue, with checkbox and Add selected highlighted

Your Jira issue is added to a flag.

Completing a Jira issue

When the Jira issue is closed or marked as complete from within the Jira UI, it is marked as complete in CloudBees Feature Management with a strikethrough in the issue number and issue name.

A completed Jira issue
Figure 4. An example Jira issue displayed as completed

Removing a Jira issue from a flag

You can remove Jira issues from any flag, regardless of completion status.

To remove a Jira issue:

  1. From the CloudBees Feature Management Home page, select Flags in environments, and then select an environment.

  2. Select a flag, and then select the Jira tab.

  3. Select the trash can icon next to the issue you want to remove.

The Jira issue is removed from the flag.