How to Automatically Transition a Linked Issue During a Workflow Transition

Create a JIRA project to use with this recipe

In this step, you are going to create a project you will use when creating a standard Story for an Epic. To do this, log on to your JIRA instance as a JIRA Administrator and do the following:

1. From the Projects menu, choose Create Project.
2. In the Select Project Type screen, select Simple Issue Tracking and click Next.
3. The second screen shows the Issue Types that will be used (Task and Sub-task). Click Select.
4. The third screen prompts you to supply a Name and Key for your new JIRA project.
   1. Use Recipe Update On Transition as the Name.
   2. Use RUOT as the Key.
   3. Click Submit to create the project, with you set as its Project Lead.
5. If you click Create and choose Recipe Update On Transition as the Project and Task as the Issue Type, you will see a Create Issue screen like the one shown to the right. Only 3 fields (Project, Issue Type, and Summary) are required, as indicated by the red asterisk next to their field labels. There are 2 optional fields: Priority and Description.

In the next step, you'll create 2 sample issues, so leave the Create Issue screen open.

Create 2 sample issues

In this step, you will create 2 sample issues that will be used to test the workflow transition you'll be adding in a later step.

1. On the Create Issue screen, fill in the fields as shown in the first table on the right and then click Create. Take note of the issue key that was created.
2. Click Create again. Then, flll in the fields as shown in the second table on the right and click Create. Take note of the issue key that was created.
3. Go to the first issue you created. and do the following:
   1. From the More menu, choose Link.
   2. Fill in the fields as shown in the screenshot to the right. (Your issue keys might be different, but you should be viewing the first issue while creating a "blocks" link from it to the second issue.)
   3. Click Link to save this link. You should now see the link showing in the "Issue Links" section of the View Issue screen.

Fields for creating the second issue:

Link screen, to link the first issue to the second issue:

Create a draft workflow

In this step, you will edit the workflow used by the Recipe Update On Transition project so you can begin the process of adding the Update Transition post function that will create a comment on the linked issue.

1. From the Cog menu ( ) , choose Projects.
2. Click the Recipe Update On Transition link to display the Project Summary page which shows how the project is configured.
3. In the Workflows section of the page, click the pencil icon () next to the RUOT: Simple Issue Tracking Workflow link to edit that workflow.
4. Click the Image Removed Text button so that the workflow is shown in Text mode rather than Diagram mode.
5. There are 2 transitions named "Done": one is in the To Do step and the other is in the In Progress step. In the next step, you will be adding a new post function to both of these transitions.

Add a post function on the Done transitions

In this step, you will add a post function on the two Done transitions.

From the RUOT: Simple Issue Tracking Workflow screen, do the following steps twice:

• once for the Done transition under the To Do step, and
• again for the Done transition under the In Progress step.

1. Click the Post Functions tab to display the post functions.
2. Click the Add post function link to display the Add Post Function To Transition screen.
3. Select Update issues and then click Add. The Add Parameters To Function screen will be displayed.
4. Set the parameters as shown to the right:
   1. Issues to Update:  This uses the %jql_result_list% substitution variable to indicate that the issue(s) being updated are based on what is returned by the JQL query specified in the JQL Query parameter.
   2. JQL Query: Thisindicates how to identify the issues to act upon. In this example, it is looking for issues that the issue currently being transitioned to Done is blocking. In other words, the current issue has a "blocks" link defined to those other issues.

   3. Comment: This indicates the comment to add to those other issues that will be updated.

      Info
      No other parameters need to be changed. JIRA will ignore any field that does not appear on the transition screen for the Done transition.

5. Click Add to save your changes to the parameters and add the Update Issues post function.

Post Function parameters:

Expand
title View Transition: Done screen, before and after adding post function...
To Do step's Transition: Done screen, before any changes:Image RemovedImage Added To Do step's Transition: Done screen, after adding post function: Image RemovedImage Added

Publish the draft workflow

In this step, you will publish the draft workflow so you can test it.

From the Transition: Done screen, do the following:

1. Click the Publish Draft button at the top of the screen to publish your draft workflow. The Publish Draft Workflow screen will appear.
2. When prompted whether to save a backup copy, click Yes and then click Publish.

Test the post function

In this step, you will verify the post function is working as intended.

1. Open the first sample issue you created. It is the one with the Summary indicating "This issue blocks another."
2. Test the To Do → Done transition:
   
   1. Click the Image Removed Done workflow button to execute the To Do → Done transition.
   2. Accept the default values on the transition screen that appears and click Done.
   3. The first sample issue should now appear in a Done status.
   4. In the Issue Links section of the screen, click the link to the second sample issue that has the Summary indicating "This issue is blocked by another" to open it.
   5. The second sample issue should now have a comment added that matches what you specified in the post function in Step 3.
3. Test the In Progress → Done transition:
   1. Go back to the first sample issue you created. It is the one with the Summary indicating "This issue blocks another."
   2. Click the Image Removedthe Reopen and start progress workflow button to reopen the first sample issue and move it to the In Progress status.
   3. Next, click the Image Removed Done workflow button to execute the In Progress → Done transition.
   4. The first sample issue should again appear in a Done status.
   5. In the Issue Links section of the screen, click the link to the second sample issue that has the Summary indicating "This issue is blocked by another" to open it.
   6. The second sample issue should now have a second comment added that matches what you specified in the post function in Step 3.

That's it! By adding a post function to add a comment to each linked issue when the issue blocking it has been resolved, you can be assured that the Assignee of those other issues is notified immediately that work can now proceed. This improves communication and saves time!

Second sample issue, after the first sample issue is transitioned to Done (from the To Do status):

Second sample issue, after the first sample issue is transitioned to Done (from the In Progress status):