This rule ensures the pull request title includes a reference to an issue tracking system ticket.
Pull requests are automatically linked if the issue key included in the pull request title (e.g. “PROJECT-123 fix: Update auth flow for new users”)
- Create a logical link between planning (tracking system) and the subsequent code change (GitHub)
- Recommended requirement for SOC2 complaint
How to implement?
orbs: datree: datree/policy@latest description: A circle-ci job to enforce Datree's pull request title convention rule jobs: my_job: docker: - image: 'circleci/node:10' steps: - datree/branch-name-convention: issue_tracker: jira version: 2.1 workflows: main: jobs: - my_job: context: github-token-context
When does this rule fail?
If there is no reference to (issue tracking system) ticket number in the Pull Request title.
How to fix?
Follow the instructions on this guide.