Link pull request to a Jira ticket
  • Updated on 12 Dec 2019
  • 1 minute to read
  • Contributors
  • Share
  • Dark
    Light

Link pull request to a Jira ticket

  • Share
  • Dark
    Light

This rule ensures a Jira issue key is included in the pull request title.

By mentioning the Jira issue key in the pull request title, it's possible to create a link between a specific Jira issue to the relevant pull requests.

3x-0d413b8-Screen_Shot_2019-01-17_at_11.55.49.png

Use case(s)

  • Create a logical link between planning (Jira) and the subsequent code change (GitHub)
  • Recommended requirement for SOC2 complaint

When does this rule fail?

When a pull request is created but fails to mention a Jira issue key in the pull request title.

In order for the integration to work, the Jira ticket number must be mentioned first:
e.g. "PROJ-123 add a README file to the project"
Adding brackets will fail the integration between GitHub and Jira
e.g. "[PROJ-123] add a README file to the project"

3x-e4bed21-Screen_Shot_2019-01-17_at_12.32.46.png

How to fix?

  1. Click Edit (located at the top of the pull request page)
    3x-147154b-Greenshot_2019-01-17_12.35.49.png

  2. Edit the pull request title to include a Jira issue key and click Save
    3x-5b98498-Greenshot_2019-01-17_12.38.41.png

  3. Datree's policy check automatically ensures a Jira issue key is mentioned in the pull request title
    3x-cc637e0-Screen_Shot_2019-01-17_at_12.40.55.png


What's Next

Activate a policy
Was this article helpful?