| Name | commit-message-validator JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | |
| Summary | Validate the format of a commit message to Wikimedia Gerrit standards |
| upload_time | 2023-11-03 22:25:56 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
gerrit
git
lint
wikimedia
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
########################
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``:
.. code-block:: 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:
.. code-block:: bash
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``:
.. code-block:: yaml
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.
.. _Wikimedia commit message guidelines: https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines
.. _pre-commit: https://pre-commit.com/
.. _CONTRIBUTING.rst: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator/-/blob/main/CONTRIBUTING.rst
.. _GPL-2.0-or-later: https://www.gnu.org/licenses/gpl-2.0.html
.. _COPYING: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator/-/blob/main/COPYING
Raw data
{
"_id": null,
"home_page": "",
"name": "commit-message-validator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Bryan Davis <bd808@wikimedia.org>, Kunal Mehta <Legoktm@debian.org>",
"keywords": "gerrit,git,lint,wikimedia",
"author": "",
"author_email": "Bryan Davis <bd808@wikimedia.org>, Kunal Mehta <Legoktm@debian.org>",
"download_url": "https://files.pythonhosted.org/packages/8d/ff/c4c44521c83d2edce2492113e7ae9b6fdb993cadec628056f1b581f7b810/commit_message_validator-2.0.0.tar.gz",
"platform": null,
"description": "########################\nCommit Message Validator\n########################\n\n``commit-message-validator`` is a tool that validates git commit messages to\nthe `Wikimedia commit message guidelines`_.\n\nPlease see <https://www.mediawiki.org/wiki/commit-message-validator> for more\ndetails.\n\nUsage\n=====\n\nUse locally as a Pre-commit plugin\n----------------------------------\n\n``commit-message-validator`` can be used as a plugin for the `pre-commit`_ git\nhooks system. Add the following to your ``.pre-commit-config.yaml``:\n\n.. code-block:: yaml\n\n - repo: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator\n rev: # Fill in a tag / sha here (like v2.0.0)\n hooks:\n - id: commit-message-validator\n\nThen install the pre-commit hook:\n\n.. code-block:: bash\n\n pre-commit install --hook-type commit-msg\n\nUse with gitlab.wikimedia.org's CI/CD\n-------------------------------------\n\nA GitLab CI/CD template is provided in this repo for linting of commit\nmessages in a merge request. Add the following to your ``.gitlab-ci.yml``:\n\n.. code-block:: yaml\n\n include:\n - project: repos/ci-tools/commit-message-validator\n file: /templates/lint-merge-request.yml\n\nContributing\n============\n\nSee CONTRIBUTING.rst_ for guidelines on contributing to\n``commit-message-validator``.\n\nBug reports\n===========\n\nPlease reports bugs and feature requests at\nhttps://phabricator.wikimedia.org/tag/commit-message-validator/.\n\nLicense\n=======\n\nLicensed under the `GPL-2.0-or-later`_ license. See COPYING_ for the full\nlicense.\n\n.. _Wikimedia commit message guidelines: https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines\n.. _pre-commit: https://pre-commit.com/\n.. _CONTRIBUTING.rst: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator/-/blob/main/CONTRIBUTING.rst\n.. _GPL-2.0-or-later: https://www.gnu.org/licenses/gpl-2.0.html\n.. _COPYING: https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator/-/blob/main/COPYING\n",
"bugtrack_url": null,
"license": "",
"summary": "Validate the format of a commit message to Wikimedia Gerrit standards",
"version": "2.0.0",
"project_urls": {
"Bug tracker": "https://phabricator.wikimedia.org/tag/commit-message-validator/",
"Changelog": "https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator/-/blob/main/HISTORY.rst",
"Documentation": "https://www.mediawiki.org/wiki/commit-message-validator",
"Source code": "https://gitlab.wikimedia.org/repos/ci-tools/commit-message-validator"
},
"split_keywords": [
"gerrit",
"git",
"lint",
"wikimedia"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7bf55dc9e34e09530922c3643cc9bc1b02ff52423ef0d7a262465d6e6fc3b0c6",
"md5": "36ec0347298f81855b72e4713ad949b8",
"sha256": "ece3d7bac71f1becc90d817c5276401149804a66851153baa3f651c5fa46dc03"
},
"downloads": -1,
"filename": "commit_message_validator-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36ec0347298f81855b72e4713ad949b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25827,
"upload_time": "2023-11-03T22:25:55",
"upload_time_iso_8601": "2023-11-03T22:25:55.196915Z",
"url": "https://files.pythonhosted.org/packages/7b/f5/5dc9e34e09530922c3643cc9bc1b02ff52423ef0d7a262465d6e6fc3b0c6/commit_message_validator-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dffc4c44521c83d2edce2492113e7ae9b6fdb993cadec628056f1b581f7b810",
"md5": "efd003ed5d006b27bebdfea029f94c5e",
"sha256": "5d718cd271a2dfd06a4473e126dec9065134429e4f9dd37b90dad441a85431f0"
},
"downloads": -1,
"filename": "commit_message_validator-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "efd003ed5d006b27bebdfea029f94c5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26178,
"upload_time": "2023-11-03T22:25:56",
"upload_time_iso_8601": "2023-11-03T22:25:56.728824Z",
"url": "https://files.pythonhosted.org/packages/8d/ff/c4c44521c83d2edce2492113e7ae9b6fdb993cadec628056f1b581f7b810/commit_message_validator-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 22:25:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commit-message-validator"
}
