commit-message-validator


Namecommit-message-validator JSON
Version 2.1.0 PyPI version JSON
download
home_pageNone
SummaryValidate the format of a commit message to Wikimedia Gerrit standards
upload_time2024-05-24 22:45:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseNone
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": null,
    "name": "commit-message-validator",
    "maintainer": null,
    "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": null,
    "author_email": "Bryan Davis <bd808@wikimedia.org>, Kunal Mehta <Legoktm@debian.org>",
    "download_url": "https://files.pythonhosted.org/packages/34/bb/82d6fb165dca031537ffebf1797c6e38313c76e3f3f9dfa70ade580155a9/commit_message_validator-2.1.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": null,
    "summary": "Validate the format of a commit message to Wikimedia Gerrit standards",
    "version": "2.1.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": "607b2eb43669d397df4c36c9fc60ef8f82d679162d63a9cec6b6bf925a2f29de",
                "md5": "e5559289a858335261284c89a7716d45",
                "sha256": "dbab37b7937521faa20fb666aaee0680f350db35e05d04e6fea38a74a3a30ac5"
            },
            "downloads": -1,
            "filename": "commit_message_validator-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e5559289a858335261284c89a7716d45",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 26169,
            "upload_time": "2024-05-24T22:45:50",
            "upload_time_iso_8601": "2024-05-24T22:45:50.871340Z",
            "url": "https://files.pythonhosted.org/packages/60/7b/2eb43669d397df4c36c9fc60ef8f82d679162d63a9cec6b6bf925a2f29de/commit_message_validator-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34bb82d6fb165dca031537ffebf1797c6e38313c76e3f3f9dfa70ade580155a9",
                "md5": "39ba7280f6bc0f4968b52ddeaa9b8123",
                "sha256": "1b52546c264b69e7988f53de2bf387ca5e0261b152c4700738633998a16da5fb"
            },
            "downloads": -1,
            "filename": "commit_message_validator-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "39ba7280f6bc0f4968b52ddeaa9b8123",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 27474,
            "upload_time": "2024-05-24T22:45:52",
            "upload_time_iso_8601": "2024-05-24T22:45:52.306131Z",
            "url": "https://files.pythonhosted.org/packages/34/bb/82d6fb165dca031537ffebf1797c6e38313c76e3f3f9dfa70ade580155a9/commit_message_validator-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-24 22:45:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "commit-message-validator"
}
        
Elapsed time: 3.29584s