Commit grammar
Default ignores
Headers that git and forges generate, passed without linting.
default-ignores defaults to true, and every preset sets it. Matching
headers pass without parsing, as in
commitlint.
[commit]
default-ignores = false| Kind | Headers |
|---|---|
| Merges | Merge pull request ..., Merge branch ..., Merge tag ..., Merge x into y, Merge remote-tracking branch ... |
| Forge merges | Merged x in y, Merged x into y, Merged PR 1: ..., Automatic merge ..., Auto-merged x into y |
| Reverts | Revert ..., revert ..., Reapply ..., reapply ... |
| Autosquash | fixup! ..., squash! ..., amend! ... |
| Release bumps | A semver version, with optional v, optionally behind chore: or chore(<scope>):, with an optional skip marker |
The skip marker is skip ci or ci skip, joined by a space or -, in
any case, inside [...] or (...).
Examples
| Header | Ignored |
|---|---|
Merge pull request #369 from x/y | Yes |
Merge conflicts resolved | No |
merge branch 'main' | No |
Merged PR 123: fix stuff | Yes |
Merged PR 123 | No |
Revert "add(lib): something" | Yes |
Reverted the change | No |
fixup! add(lib): something | Yes |
fixup add(lib): something | No |
chore(release): v1.2.3 | Yes |
1.2.3 (CI-Skip) | Yes |
release: v1.2.3 | No |
1.2.3 [skip ci] and more | No |
1.2 | No |