commit-message-validator

Translate this page

commit-message-validator is a tool that validates commit messages to our commit message guidelines. It requires Python 3.6+. The preferred method of installation is to use pre-commit.

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.1.0)
  hooks:
    - id: commit-message-validator

Then install the pre-commit hook:

pre-commit install --hook-type commit-msg

The git hook will run after you make the commit, and tell you about any errors you might have made so you can go back and amend your change.

Use with gitlab.wikimedia.org's CI/CD

A GitLab CI/CD template is provided in the project 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

External links