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:50:04 +02:00
parent 5739f6105c
commit 81be8b43a8
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,3 +1,22 @@
# 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.
### 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
```