actions/action-conventional-commits
actions/action-conventional-commits
1
0
Fork 0
mirror of https://github.com/webiny/action-conventional-commits.git synced 2024-11-23 10:21:51 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update README

Browse source
This commit is contained in:
Adrian Smijulj 2020-06-11 09:55:51 +02:00 committed by GitHub
parent 6ebe9a2c41
commit f343af4218
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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