You can configure a workflow in the issues application, so that the workflow can be actioned by the completion of a build (see Actioning issues via builds for additional information). For example, you can configure a workflow to automatically progress an issue from 'Building' to 'Resolved' status when an build related to that issue (i.e. JIRA issue key added to commit message) has successfully completed. Alternatively, you can configure the same workflow to progress an issue from 'Building' to 'Build Broken' status if a build related to that issue fails.
A Builds Workflow exists in JIRA and it incorporates the common statuses and transitions (see the Understanding the 'Builds Workflow' section below).
- If you are new to JIRA and Bamboo, we recommend that you use the 'Builds Workflow' as modifying an existing workflow is not a trivial task.
- If you have an existing workflow that you would like to modify to include build statuses and transitions, we recommend that you take a copy of the 'Builds Workflow' and modify it.
- If you want to integrate Bamboo transitions into your existing workflow, you can edit your workflow to add the transitions. We recommend that you avoid doing unless you have a good understanding of JIRA workflows.
Understanding the 'Builds Workflow'
Diagram: The default Builds Workflow
Wait for Build
The 'Wait for Build', 'Build Passed' and 'Build Failed' transitions are Bamboo-specific transitions:
- 'Wait for Build' — This transition will be triggered when code is committed for this issue (and a build started) using the
#wait-for-build. Note, you must manually enter the commit command in your commit message to trigger the transition, as described in Using smart commits.
- 'Build Passed' — This transition will be automatically triggered when a build for this issue passes.
- 'Build Failed' — This transition will be automatically triggered when a build for this issue fails.
Using the 'Builds Workflow' in your projects
The following instructions describe how to create a workflow scheme that uses the 'Builds Workflow', and then associate the workflow scheme with a project. If you want to add the 'Builds Workflow' to an existing workflow scheme, ignore steps 4-6 below and assign the workflow to your existing workflow scheme instead.
1. Creating a workflow scheme that uses the Builds Workflow
- Log in as an admin for your site.
- In the JIRA administration console, go to Workflows > Workflow Schemes. The 'Workflow Schemes' page will display.
- Click Add workflow scheme. The 'Add Workflow Scheme' page will display.
- Enter a Name and Description for your workflow scheme and click Add. Your workflow scheme will be created and you will see the page for editing the workflow.
- Click the Assign a workflow link. The 'Add Workflow to Scheme' page will display.
- In the Issue Type dropdown, select the issue types that you want the 'Builds Workflow' to apply to. In the Workflow drop-down list, select Builds Workflow. Click Add. The 'Builds Workflow' to your new workflow scheme for the selected issue types.
2. Associating the workflow scheme with your project
- Log in as a user with the JIRA Administrators global permission.
Choose> Projects, and click the name of a project. The Project Summary page is displayed.
Keyboard shortcut: g + g + start typing projects
Click Workflows on the left of the Project Summary page (you can also click the More link in the Workflows section in the middle of the screen). The Workflows page is displayed, indicating the current workflow scheme used by the project.
Click the Switch Scheme link to display the Associate Workflow Scheme to Project page.
- Select the relevant workflow scheme from the Scheme list and click the Associate button to begin the migration process. The 'Builds Workflow' will be associated with your project via your workflow scheme.
- Click Acknowledge to finish the process. A message displays letting you know that 'your workflows have been published.'
- Select the project you wish to use the 'Builds Workflow' with. The project summary page appears.
Issues (of the issue types specified in your workflow scheme) will now use the 'Builds Workflow'. If you add the issue key of an issue to the commit message when committing, the issue will be automatically transitioned along the workflow when the build starts/succeeds/fails.
Modifying the 'Builds Workflow'
You cannot modify the 'Builds Workflow' itself because it is non-editable. However, you can copy it and edit the copy if the original 'Builds Workflow' doesn't suit the needs of your project. You can then activate the new (copied) workflow by adding it to a workflow scheme and then associating that scheme with your projects.
Copying and editing the 'Builds Workflow'
- Log in as an admin for your site.
- In the JIRA administration console, go to Schemes > Workflow Schemes. The 'Workflow Schemes' page will display.
- Click the View all workflows link. The 'View Workflows' page will display.
- Locate the Builds Workflow and click Copy in the 'Operations' column.
- Enter a Name and Description for the new (copied) workflow scheme and click Copy. The new workflow will be created and displayed on the 'View Workflows' page.
- You can now edit and activate your new workflow as needed. See Configuring Workflow and Activating workflow in the JIRA documentation for more information on how to do this.
Integrating build transitions into your custom workflow
If modifying a copy of the 'Builds Workflow' is not feasible for your projects, it is possible to manually modify your existing workflow to include the Bamboo transitions. It is recommended that you avoid doing so unless you have a good understanding of JIRA workflows.
To integrate build transitions into your existing custom workflow, edit your workflow and configure appropriate issue statuses and issue transitions as described below.
Configuring your issue statuses
We recommend that you set up issue statuses for your workflow to indicate when a build related to an issue is building or the build is broken (e.g. 'Building', 'Build Broken'). There is no technical restriction preventing you from incorporating Bamboo-specific build transitions into a JIRA workflow without these intermediate states, however, in practice it will cause problems.
For example, a developer may work on an issue, and commit several times over the course of a few days for that issue.
Even if earlier commits cause the build to pass, the developer may not have finished working on the issue and will need to commit more code without successful builds resolving the issue. Hence, an intermediate state (e.g. 'Building') is required which a developer will only transition the issue into (i.e. using the
#build commit command), if they want the issue to be resolved from that particular build.
Configuring your issue transitions
Automatic issue transitioning via builds is controlled by both commit commands and Bamboo-specific transition properties in JIRA, as described below:
- Commit Command — Commit commands are mapped to transition names. Hence, if you add the 'Waiting for Build' transition to your workflow, your users will be able to automatically trigger the transition by using the
#wait-for-buildcommit command in their commit messages.
Bamboo-specific transition properties— The Bamboo-specific transition properties on the transitions that you want to be triggered when a Bamboo build passes or fails. The following properties are supported:
A transition with this property will be triggered when a build for this issue passes, and the transition is available to the issue in its current state.
A transition with this property will be triggered when a build for this issue fails, and the transition is available to the issue in its current state.
any valid resolution, e.g. 'Fixed'
The issue resolution will be set as specified by this property, if the transition with this property is triggered by a build.
Please note, you cannot set up common transition properties in JIRA. You will need to manually re-enter the transition property on each transition that you want it added to.