This rule ensures the branch name includes a reference to an issue tracking system ticket.
Branches are linked automatically to your issue tracking system if the issue key included in the branch name (e.g. git branch “features/PROJECT-549”)
- Create a logical link between planning (tracking system) and the subsequent code change (Git)
- Recommended requirement for SOC2 complaint
How to implement?
orbs: datree: datree/policy@latest description: A circle-ci job to enforce Datree's branch name 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
When does this rule fail?
If there is no reference to (issue tracking system) ticket number in the branch name.
How to fix?
Follow the instructions on this guide.