mirror of
https://github.com/webiny/action-conventional-commits.git
synced 2024-11-10 12:09:34 +01:00
docs: update README
This commit is contained in:
parent
e8c2db1db9
commit
0cc64c05ba
1 changed files with 4 additions and 4 deletions
|
@ -7,7 +7,7 @@ A simple GitHub action that makes sure all commit messages are following the [Co
|
||||||
Note that, typically, you would make this check on a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can easily be skipped, hence this GitHub action.
|
Note that, typically, you would make this check on a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can easily be skipped, hence this GitHub action.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
Latest version: `v1.1.0`
|
Latest version: `v1.2.0`
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
name: Conventional Commits
|
name: Conventional Commits
|
||||||
|
@ -24,7 +24,7 @@ jobs:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- uses: webiny/action-conventional-commits@v1.1.0
|
- uses: webiny/action-conventional-commits@v1.1.0
|
||||||
# optional, required for private repos
|
with:
|
||||||
# with:
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Optional, for private repositories.
|
||||||
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
allowed-commit-types: "feat,fix" # Optional, set if you want a subset of commit types to be allowed.
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue