Crucible 2.8 : Using JIRA Integration in Crucible Reviews

This page contains information on how to use JIRA integration with Crucible reviews.

On this page:

(info) Before you begin, both your Crucible and JIRA instances must be configured to use make use of these JIRA integration features. The Crucible project requires a linked JIRA project before issues can be linked to reviews. Read more.

1. Create a JIRA Issue for your Review

To use JIRA integration, you must begin with a JIRA issue that you will use as the parent issue for the review. Crucible will create and resolve sub-tasks belonging to this parent issue. Once your parent issue is created, make a note of its issue key, e.g. FE-1968.

2. Create Your Review and Link it to a JIRA Issue

When creating your review, you have an option called 'Linked Issue'. Crucible may put a suggested JIRA issue key into this field automatically if a JIRA key is found in the review title. You can specify a different issue key and click 'Link' to save it. You can also click the 'x' to clear the field and load a different issue key.

Screenshot: Selecting a JIRA Issue When Creating a Review

You can also link a JIRA issue to the review after the review is created. When viewing a review, the details pane of the review shows meta-information. One of the links in this area is titled 'Linked JIRA Issue:' and then a suggested JIRA issue key. Click this link to associate that JIRA issue with this review.

3. Make a Comment or Defect on the Review

Once your review has a linked JIRA issue, create a comment or defect comment anywhere on the review. Once created, the comment actions will show a link titled 'Create Issue' (note that this link does not appear on replies — only on new comments). You can click that to instantly create a sub-task under the parent JIRA, which will take the content of the comment as its summary.

Screenshot: Selecting a JIRA Issue From a Comment

4. Click to create a JIRA Sub-Task

Clicking the 'Create Issue' link will allow you to create a JIRA sub-task under the parent JIRA issue, e.g.:

Screenshot: The JIRA 'Create Issue' dialog

(info) The list of possible assignees will include:

  • 'Automatic' (i.e. the default assignee for that JIRA project)
  • the assignee of the subtask's parent issue
  • the reporter of the subtask's parent issue
  • 'Unassigned' (if your JIRA administrator has enabled Allow Unassigned)
  • plus, if Trusted Applicationshave been configured between JIRA and Crucible,
    • the review author
    • the review moderator
    • the comment/defect author
    • yourself

Once created, the sub-task JIRA issue key, status and default action (i.e. 'Resolve') will be shown. If you hover your mouse over the JIRA issue key, an information window will show more information and controls relating to that JIRA issue.

Screenshot: The JIRA Hover information window

(info) Users are mapped to their own accounts when using Trusted Applications. If you don't have the permissions to carry out the default action ('Resolve', in this case), an error will occur.

5. Resolve the JIRA issue through Crucible

Once the work required on your sub-task is completed, simply click the action link provided to signal that this has occurred (e.g. 'Resolve'). The JIRA issue will be closed.

If you encounter problems or have trouble using JIRA integration, please read the FAQ page on this topic.