Commit Message Validator
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-validatorThen install the pre-commit hook:
pre-commit install --hook-type commit-msgUse 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.ymlContributing
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.
2 maintainers
Release files for commit-message-validator 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| commit_message_validator-3.0.0.tar.gz | 27.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| commit_message_validator-3.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.8 kB
Release files / commit_message_validator-3.0.0.tar.gz
| Download URL | commit_message_validator-3.0.0.tar.gz |
|---|---|
| Size | 27.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0f673697ca62f833e09e2f9630d2461e898a9f9baf0543b35de8603a0508b21
|
|
BLAKE2b-256 checksum How to use checksums |
ed455a3d5dcf61702badc30189f9ac4fbf5e302bcf7727570d50651560a03cdb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
Release files / commit_message_validator-3.0.0-py3-none-any.whl
| Download URL | commit_message_validator-3.0.0-py3-none-any.whl |
|---|---|
| Size | 26.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9ab3d6b305b047187ea92bdfc0a2dafc10135362dcaf97c974617332abe0b2ed
|
|
BLAKE2b-256 checksum How to use checksums |
971e8fac37590599c0c5596b638e14fb00706bd1d248c64b27f4c3d7b3f26dfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
