git
6 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
git/author-identity-domain | warning | Every commit in the build range was authored and committed by an address on a domain the organisation controls. |
git/changed-files-budget | info | The build range changes few enough files that a reviewer can hold the whole change in their head. |
git/conventional-commits | error | Every commit message in the build range follows the Conventional Commits specification: the subject line, the blank line before the body, and the BREAKING CHANGE footer. |
git/no-merge-commits | warning | The build range contains no merge commits. |
git/no-wip-commits | warning | The build range carries no commit that says it was never meant to be merged. |
git/work-item-reference | warning | Every commit in the build range, or the branch it is on, names the change record it belongs to. |
Shared inputs
Every git guardrail declares these inputs, and each one may add its own.
| Input | Description | Default |
|---|---|---|
baseRef | Ref the range starts at. The commits checked are <baseRef>..HEAD. | origin/main |
Shared collectors
Every git guardrail is handed the facts these collectors gather, and each one may ask for more of its own.
| Collector | Gathers |
|---|---|
git | The repository, HEAD, the remotes, and every commit between the base ref and HEAD with its message, author, parents and the files the range changed. |
Every guardrail in this category is configured the same way, in the guardrails.checks array of buildnote.json. See Configuring guardrails for every option, and Guardrails to search the whole library.