mirror of
https://github.com/webiny/action-conventional-commits.git
synced 2024-11-10 12:09:34 +01:00
chore: update README
This commit is contained in:
parent
6ebe9a2c41
commit
f343af4218
1 changed files with 4 additions and 1 deletions
|
@ -1,8 +1,11 @@
|
||||||
# Conventional Commits GitHub Action
|
# Conventional Commits GitHub Action
|
||||||
|
|
||||||
A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification.
|
A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. If not, workflow will fail.
|
||||||
|
|
||||||
|
Typically, you would make these check in a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can be easily skipped, hence this GitHub action.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
Latest version: `v1.0.1`
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
name: My Workflow
|
name: My Workflow
|
||||||
|
|
Loading…
Reference in a new issue