Package: commit-check
OverviewCommit 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 readidentify branch according to the branch typetriggering the specific types of commit/branch CI buildautomatically generate changelogsConfigurationUse custom configurationCreate a config file.commit-check.ymlunder your repository root directory, e.g..commit-check.ymlUse default configurationIf you did’t set.commit-check.yml,commit-checkwill use thedefault configuration.i.e. the commit message will follow the rules ofconventional commits,
branch naming follow bitbucketbranching model.UsageThere are a variety of ways you can use commit-check as follows.Running as GitHub ActionPlease seecommit-check/commit-check-actionRunning as pre-commit hookTipMake surepre-commitisinstalled.-repo:https://github.com/commit-check/commit-checkrev:the tag or revisionhooks:# support hooks-id:check-message-id:check-branch-id:check-author-name-id:check-author-email-id:check-commit-signoffRunning as CLIGlobal installationsudopip3install-Ucommit-checkUser installationpipinstall-Ucommit-checkInstall from git repopipinstallgit+https://github.com/commit-check/commit-check.git@mainThen you can runcommit-checkcommand line. More aboutcommit-check--helpplease seedocs.Running as Git HooksTo 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/shcommit-check--message--branch--author-name--author-emailSave the script file topre-pushand make it executable by running the following command:chmod+x.git/hooks/pre-pushThen when you rungit pushcommand, this push hook will be run automatically.ExampleCheck commit message failedCommit 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 regexCheck branch naming failedCommit 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 repositoryYou 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-checkVersioningVersioning followsSemantic Versioning.Have question or feedback?To provide feedback (requesting a feature or reporting a bug) please post toissues.LicenseThis project is released under theMIT License