action-conventional-commits/README.md

23 lines
471 B
Markdown
Raw Normal View History

2020-06-11 09:05:03 +02:00
# Conventional Commits GitHub Action
2020-06-11 09:04:45 +02:00
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.
2020-06-11 09:50:04 +02:00
### Usage
```yml
2020-06-11 09:50:55 +02:00
name: My Workflow
2020-06-11 09:50:04 +02:00
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
```