mirror of
https://github.com/webiny/action-conventional-commits.git
synced 2024-11-23 02:11:47 +01:00
Ensures that all commits are following the conventional-commits standard.
| dist/main | ||
| docs | ||
| src | ||
| .gitignore | ||
| .prettierrc.js | ||
| action.yml | ||
| babel.config.js | ||
| CONTRIBUTING.md | ||
| index.js | ||
| jest.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Conventional Commits GitHub Action
A simple GitHub action that makes sure all commit messages are following the Conventional Commits specification.
Note that, typically, you would make this check on a pre-commit hook (for example, using something like Commitlint), but those can easily be skipped, hence this GitHub action.
Usage
Latest version: v1.3.0
name: Conventional Commits
on:
pull_request:
branches: [ master ]
jobs:
build:
name: Conventional Commits
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: webiny/action-conventional-commits@v1.3.0
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Optional, for private repositories.
allowed-commit-types: "feat,fix" # Optional, set if you want a subset of commit types to be allowed.