chore: allow ! to indicate breaking changes (#10430)

* chore: allow `!` to indicate breaking changes

* chore: update commit convention too

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
ckohen
2024-08-08 14:50:20 -07:00
committed by GitHub
parent 5c90b7f716
commit 54303d085d
3 changed files with 5 additions and 3 deletions

View File

@@ -7,6 +7,7 @@
"always", "always",
["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types"] ["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types"]
], ],
"scope-case": [0] "scope-case": [0],
"subject-exclamation-mark": [0]
} }
} }

View File

@@ -7,7 +7,7 @@
Messages must be matched by the following regex: Messages must be matched by the following regex:
```js ```js
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\(.+\))?: .{1,72}/; /^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\(.+\))?!?: .{1,72}/;
``` ```
#### Examples #### Examples
@@ -55,6 +55,7 @@ A commit message consists of a **header**, **body** and **footer**. The header h
``` ```
The **header** is mandatory and the **scope** of the header is optional. The **header** is mandatory and the **scope** of the header is optional.
If the commit contains **Breaking Changes**, a `!` can be added before the `:` as an indicator.
### Revert ### Revert

View File

@@ -26,7 +26,7 @@ jobs:
env: env:
TITLE: ${{ github.event.pull_request.title }} TITLE: ${{ github.event.pull_request.title }}
run: | run: |
REGEX="^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\\(.+\\))?: .{1,72}$" REGEX="^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\\(.+\\))?!?: .{1,72}$"
echo "Title: \"$TITLE\"" echo "Title: \"$TITLE\""