We connect PRs and commits to Jira tickets by checking if they contain a JIRA Issue Key (i.e. <project id>-<number>) that matches a Jira issue record in our Data Base.
For PRs, we check the PR title, body, or head ref for issue IDs.
For commits, we check the commit message. We also check the PR associated with the commit - if the individual commit doesn’t contain an ID but the PR it’s associated with does, it will be considered traceable.
How do we know which commits or PRs have been associated with Jira issues?
We use numbers in commit messages or - if a PR is associated with the commit - in the PR title, body, or head ref to associate issues with commits and count traceability. In turn, this shows the portion of code changes that are tracked by an issue.
Learn more about Traceability here.
Troubleshooting Traceability: Why is my commit not shown as traceable in Velocity?
If Velocity is showing a certain commit is not traceable, use the following steps to troubleshoot:
Confirm that the commit message includes a Jira Issue Key (i.e. ENG-123). *Note: the "message title" seen in Velocity drilldowns is only the commit title, but Velocity searches for issue keys in the commit message. Head here to learn how to search for commit messages.
If an issue key is not included in the commit message, confirm that the issue key is included in the related PR's title, body, or head ref (head branch name).
Confirm that the Jira issue has been ingested by Velocity. Using Analytics, search for Issues opened, and filter to the relevant project and date range. In the results, drilldown to the relevant board to view a list of all issues opened.
If the issue is not listed in the Analytics results, it's likely that Velocity hasn't ingested the issue from your Jira project. Confirm that the Jira project has been added to Velocity (via your Projects settings). If the project is connected to Velocity, but you're still unable to locate the relevant issue in the Analytics tab, contact support for assistance. Please include the name of the project, the issue key, and a screenshot of the commit message, PR title, body, and head ref from GitHub.