A simple GitHub action that makes sure all commit messages are following the Flowing Code Commit Message Guidelines, based on 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.
- The commit message must contain at least a type and a subject (
type:subject), with an optional scope (type(scope):subject) - The commit type must be one of
feat,fix,remove,deprecate,refactor,build,perf,chore,ci,style,docs,test,revert - The first line of the commit message must not exceed 72 characters.
- Commit type must be all lowercase.
- Commit subject must start with lowercase.
- There must be a single space after the commit type.
- Commits of type
revert:must begin with the type of the reverted commit (e.g.revert: feat: something) - Changes of type
deprecate:,test:,ci:,style:anddocs:must not be breaking. - Commits of type
remove:must be breaking changes (i.e.remove!: something)
After the action completes, the SEMVER_LEVEL environment variable is set according to the highest level of Semantic Versioning change described by the commit messages:
| Level | Value | Commit types |
|---|---|---|
| MAJOR | 3 | breaking changes (!), remove |
| MINOR | 2 | feat, deprecate |
| PATCH | 1 | fix, refactor, build, perf, chore |
| NONE | 0 | ci, style, docs, test, revert* |
* revert is classified as NONE because the level of semantic versioning change cannot be decided from the commit message alone.
Latest version: v1.1.0
name: Conventional Commits
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.1.0