commit-message-validator 2.1.0

Description:

commitmessagevalidator 2.1.0

commit-message-validator is a tool that validates git commit messages to
the Wikimedia commit message guidelines.
Please see <https://www.mediawiki.org/wiki/commit-message-validator> for more
details.

Usage

Use locally as a Pre-commit plugin
commit-message-validator can be used as a plugin for the pre-commit git
hooks system. Add the following to your .pre-commit-config.yaml:
- repo: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator
rev: # Fill in a tag / sha here (like v2.0.0)
hooks:
- id: commit-message-validator
Then install the pre-commit hook:
pre-commit install --hook-type commit-msg


Use with gitlab.wikimedia.org’s CI/CD
A GitLab CI/CD template is provided in this repo for linting of commit
messages in a merge request. Add the following to your .gitlab-ci.yml:
include:
- project: repos/ci-tools/commit-message-validator
file: /templates/lint-merge-request.yml



Contributing
See CONTRIBUTING.rst for guidelines on contributing to
commit-message-validator.


Bug reports
Please reports bugs and feature requests at
https://phabricator.wikimedia.org/tag/commit-message-validator/.


License
Licensed under the GPL-2.0-or-later license. See COPYING for the full
license.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter