Customizable Conventional Commits
ActionsEnforce conventional-commits standard, allowing customization of allowed commit types
v1.2.1
LatestBy aprets
Tags
(1)Compared to the upstream version this fork allows you to customize the allowed commit types. This lets you allow types like enh
.
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 require extra configuration and can theoretically easily be skipped, hence this GitHub action.
name: Conventional Commits
on:
pull_request:
branches: [ master ]
jobs:
build:
name: Conventional Commits
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: gentleseal/action-conventional-commits@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
This will use the default allowed types of:
[
"feat",
"fix",
"docs",
"style",
"refactor",
"test",
"build",
"ci",
"chore",
"revert",
"merge",
"wip",
]
name: Conventional Commits
on:
pull_request:
branches: [ master ]
jobs:
build:
name: Conventional Commits
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: gentleseal/action-conventional-commits@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
valid-commit-types: >
[
"feat",
"fix",
"docs",
"style",
"refactor",
"test",
"build",
"ci",
"chore",
"revert",
"merge",
"wip",
"enh"
]
Customizable Conventional Commits is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.