mirror of
https://github.com/webiny/action-conventional-commits.git
synced 2024-11-23 10:21:51 +01:00
chore: update README
This commit is contained in:
parent
5739f6105c
commit
81be8b43a8
1 changed files with 19 additions and 0 deletions
19
README.md
19
README.md
|
@ -1,3 +1,22 @@
|
||||||
# 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.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```yml
|
||||||
|
name: Build
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Conventional Commits
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- uses: webiny/action-conventional-commits@v1.0.1
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue