Check commit message formatting, branch naming, commit author, email, and more.
Project description
Overview
Commit Check is open source alternative to Yet Another Commit Checker.
It supports checking commit message, branch naming, committer name/email, commit signoff and customizing error message and suggest command (tell me more, please).
commit-check is a tool designed for teams. Its main purpose is to standardize the format of commit message, branch naming, etc, and makes it possible to:
writing descriptive commit is easy to read
identify branch according to the branch type
triggering the specific types of commit/branch CI build
automatically generate changelogs
Configuration
Use custom configuration
Create a config file .commit-check.yml under your repository root directory, e.g. .commit-check.yml
Use default configuration
If you did’t set .commit-check.yml, commit-check will use the default configuration.
i.e. the commit message will follow the rules of conventional commits, branch naming follow bitbucket branching model.
Usage
There are a variety of ways you can use commit-check as follows.
Running as GitHub Action
Please see commit-check/commit-check-action
Running as pre-commit hook
- repo: https://github.com/commit-check/commit-check
rev: the tag or revision
hooks: # support hooks
- id: check-message
- id: check-branch
- id: check-author-name
- id: check-author-email
- id: check-commit-signoff
Running as CLI
Global installation
sudo pip3 install -U commit-check
User installation
pip install -U commit-check
Install from git repo
pip install git+https://github.com/commit-check/commit-check.git@main
Then you can run commit-check command line. More about commit-check --help please see docs.
Running as Git Hooks
To configure the hook, you need to create a new script file in the .git/hooks/ directory of your Git repository.
Here is an example script that you can use to set up the hook:
#!/bin/sh
commit-check --message --branch --author-name --author-email
Save the script file to pre-push and make it executable by running the following command:
chmod +x .git/hooks/pre-push
Then when you run git push command, this push hook will be run automatically.
Example
Check commit message failed
Commit rejected by Commit-Check.
(c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
/ ._. \ / ._. \ / ._. \ / ._. \ / ._. \
__\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
|| E || || R || || R || || O || || R ||
_.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
`-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
Type message check failed => my test commit message
It doesn't match regex: ^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
More details please refer to https://www.conventionalcommits.org
Suggest: please check your commit message whether matches above regex
Check branch naming failed
Commit rejected by Commit-Check.
(c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c)
/ ._. \ / ._. \ / ._. \ / ._. \ / ._. \
__\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
|| E || || R || || R || || O || || R ||
_.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
`-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´
Commit rejected.
Type branch check failed => my-test-branch
It doesn't match regex: ^(bugfix|feature|release|hotfix|task)\/.+|(master)|(main)|(HEAD)|(PR-.+)
Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/
Suggest: run command `git checkout -b type/branch_name`
Badging your repository
You can add a badge to your repository to show your contributors / users that you use commit-check!
Markdown
[![commit-check](https://img.shields.io/badge/commit--check-enabled-brightgreen?logo=Git&logoColor=white)](https://github.com/commit-check/commit-check)
reStructuredText
.. image:: https://img.shields.io/badge/commit--check-enabled-brightgreen?logo=Git&logoColor=white
:target: https://github.com/commit-check/commit-check
:alt: commit-check
Versioning
Versioning follows Semantic Versioning.
Have question or feedback?
To provide feedback (requesting a feature or reporting a bug) please post to issues.
License
This project is released under the MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for commit_check-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 795386233a646dd48622abc974b6ff99c772330c29c367d6b3806025b7d81508 |
|
MD5 | f5219d35971f22277d47c8f5e6f775c3 |
|
BLAKE2b-256 | af24dbcaa7e2d5b5f0d52a2fb13a8cf37d57c375c2b3df65a634a7875432ea1f |