A pre-commit
hook to check commit messages for
Conventional Commits formatting.
Works with Python >= 3.8.
Make sure pre-commit
is installed.
Create a blank configuration file at the root of your repo, if needed:
touch .pre-commit-config.yaml
Add a new repo entry to your configuration file:
repos:
# - repo: ...
- repo: https://github.com/compilerla/conventional-pre-commit
rev: <git sha or tag>
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: []
Install the pre-commit
script:
pre-commit install --hook-type commit-msg
Make a (normal) commit ❌:
$ git commit -m "add a new feature"
[INFO] Initializing environment for ....
Conventional Commit......................................................Failed
- hook id: conventional-pre-commit
- duration: 0.07s
- exit code: 1
[Bad Commit message] >> add a new feature
Your commit message does not follow Conventional Commits formatting
https://www.conventionalcommits.org/
Conventional Commits start with one of the below types, followed by a colon,
followed by the commit message:
build chore ci docs feat fix perf refactor revert style test
Example commit message adding a feature:
feat: implement new API
Example commit message fixing an issue:
fix: remove infinite loop
Example commit with scope in parentheses after the type for more context:
fix(account): remove infinite loop
Example commit with a body:
fix: remove infinite loop
Additional information on the issue caused by the infinite loop
Make a (conventional) commit ✔️:
$ git commit -m "feat: add a new feature"
[INFO] Initializing environment for ....
Conventional Commit......................................................Passed
- hook id: conventional-pre-commit
- duration: 0.05s
conventional-pre-commit
can also be installed and used from the command line:
pip install conventional-pre-commit
Then run the command line script:
conventional-pre-commit [types] input
-
[types]
is an optional list of Conventional Commit types to allow (e.g.feat fix chore
) -
input
is a file containing the commit message to check:
conventional-pre-commit feat fix chore ci test .git/COMMIT_MSG
Or from a Python program:
from conventional_pre_commit.format import is_conventional
# prints True
print(is_conventional("feat: this is a conventional commit"))
# prints False
print(is_conventional("nope: this is not a conventional commit"))
# prints True
print(is_conventional("custom: this is a conventional commit", types=["custom"]))
conventional-pre-commit
supports a number of arguments to configure behavior:
$ conventional-pre-commit -h
usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
Check a git commit message for Conventional Commits formatting.
positional arguments:
types Optional list of types to support
input A file containing a git commit message
options:
-h, --help show this help message and exit
--force-scope Force commit to have scope defined.
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
Supply arguments on the command-line, or via the pre-commit hooks.args
property:
repos:
- repo: https://github.com/compilerla/conventional-pre-commit
rev: <git sha or tag>
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: [--strict, --force-scope, feat, fix, chore, test, custom]
NOTE: when using as a pre-commit hook, input
is supplied automatically (with the current commit's message).
conventional-pre-commit
comes with a VS Code devcontainer
configuration to provide a consistent development environment.
With the Remote - Containers
extension enabled, open the folder containing this repository inside Visual Studio Code.
You should receive a prompt in the Visual Studio Code window; click Reopen in Container
to run the development environment
inside the devcontainer.
If you do not receive a prompt, or when you feel like starting from a fresh environment:
Ctrl/Cmd+Shift+P
to bring up the command palette in Visual Studio Code- Type
Remote-Containers
to filter the commands - Select
Rebuild and Reopen in Container
to completely rebuild the devcontainer - Select
Reopen in Container
to reopen the most recent devcontainer build
Versioning generally follows Semantic Versioning.
Releases to PyPI and GitHub are triggered by pushing a tag.
- Ensure all changes for the release are present in the
main
branch - Tag with the new version:
git tag vX.Y.Z
for regular release,git tag vX.Y.Z-preN
for pre-release - Push the new version tag:
git push origin vX.Y.Z
Inspired by matthorgan's pre-commit-conventional-commits
.