# commitlint
[](https://badge.fury.io/py/commitlint)
[](https://github.com/opensource-nepal/commitlint/actions)
[](https://pypi.org/project/commitlint/)
[](https://codecov.io/github/opensource-nepal/commitlint)
[](https://github.com/opensource-nepal/commitlint/blob/main/LICENSE)
commitlint is a tool designed to lint your commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/) standard for your pre-commit hook and GitHub Actions.
## How to use
### For pre-commit
1. Add the following configuration on `.pre-commit-config.yaml`.
```yaml
repos:
...
- repo: https://github.com/opensource-nepal/commitlint
rev: v0.2.1
hooks:
- id: commitlint
...
```
2. Install the `commit-msg` hook in your project repo:
```bash
pre-commit install --hook-type commit-msg
```
> **_NOTE:_** Installing using only `pre-commit install` will not work.
### For github-actions
If you have any existing workflows, add the following steps:
```yaml
steps:
...
- name: Run commitlint
uses: opensource-nepal/commitlint@v0.2.1
...
```
If you don't have any workflows, create a new GitHub workflow, e.g. `.github/workflows/commitlint.yaml`.
```yaml
name: Commitlint
on:
push:
branches: ['main']
pull_request:
jobs:
commitlint:
runs-on: ubuntu-latest
name: Commitlint
steps:
- uses: actions/checkout@v4
- name: Run commitlint
uses: opensource-nepal/commitlint@v0.2.1
```
> **_NOTE:_** commitlint GitHub Actions will only be triggered by "push" or "pull_request" events.
## Contribution
We appreciate feedback and contribution to this package. To get started please see our [contribution guide](./CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/opensource-nepal/commitlint",
"name": "commitlint",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "commitlint,commit lint,python commitlint,conventional commit,conventional commit message,python commit,github actions,pre-commit",
"author": "opensource-nepal",
"author_email": "aj3sshh@gmail.com, sugatbajracharya49@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/57/be3e74525064e0c6e10d1d7747a62079c2547eab657279bf0bcbd199b661/commitlint-0.2.1.tar.gz",
"platform": null,
"description": "# commitlint\n\n[](https://badge.fury.io/py/commitlint)\n[](https://github.com/opensource-nepal/commitlint/actions)\n[](https://pypi.org/project/commitlint/)\n[](https://codecov.io/github/opensource-nepal/commitlint)\n[](https://github.com/opensource-nepal/commitlint/blob/main/LICENSE)\n\ncommitlint is a tool designed to lint your commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/) standard for your pre-commit hook and GitHub Actions.\n\n## How to use\n\n### For pre-commit\n\n1. Add the following configuration on `.pre-commit-config.yaml`.\n\n ```yaml\n repos:\n ...\n\n - repo: https://github.com/opensource-nepal/commitlint\n rev: v0.2.1\n hooks:\n - id: commitlint\n\n ...\n ```\n\n2. Install the `commit-msg` hook in your project repo:\n\n ```bash\n pre-commit install --hook-type commit-msg\n ```\n\n> **_NOTE:_** Installing using only `pre-commit install` will not work.\n\n### For github-actions\n\nIf you have any existing workflows, add the following steps:\n\n```yaml\nsteps:\n ...\n - name: Run commitlint\n uses: opensource-nepal/commitlint@v0.2.1\n ...\n```\n\nIf you don't have any workflows, create a new GitHub workflow, e.g. `.github/workflows/commitlint.yaml`.\n\n```yaml\nname: Commitlint\n\non:\n push:\n branches: ['main']\n pull_request:\n\njobs:\n commitlint:\n runs-on: ubuntu-latest\n name: Commitlint\n steps:\n - uses: actions/checkout@v4\n\n - name: Run commitlint\n uses: opensource-nepal/commitlint@v0.2.1\n```\n\n> **_NOTE:_** commitlint GitHub Actions will only be triggered by \"push\" or \"pull_request\" events.\n\n## Contribution\n\nWe appreciate feedback and contribution to this package. To get started please see our [contribution guide](./CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "commitlint is is a pre-commit hook designed to lint your commit messages according to the Conventional Commits standard.",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/opensource-nepal/commitlint/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/opensource-nepal/commitlint",
"Source": "https://github.com/opensource-nepal/commitlint"
},
"split_keywords": [
"commitlint",
"commit lint",
"python commitlint",
"conventional commit",
"conventional commit message",
"python commit",
"github actions",
"pre-commit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76430e7f08fa0ccf29a3b25580b9b53c6c3a91268561c759f977592d48e83bd6",
"md5": "766b0808f1d635aabba52a88e6f8bf71",
"sha256": "04ac9c4e0a753f8cedfa727a2b65640bfc680d7925f74c3283254959ef2bb35a"
},
"downloads": -1,
"filename": "commitlint-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "766b0808f1d635aabba52a88e6f8bf71",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20402,
"upload_time": "2024-02-01T12:33:07",
"upload_time_iso_8601": "2024-02-01T12:33:07.004076Z",
"url": "https://files.pythonhosted.org/packages/76/43/0e7f08fa0ccf29a3b25580b9b53c6c3a91268561c759f977592d48e83bd6/commitlint-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e57be3e74525064e0c6e10d1d7747a62079c2547eab657279bf0bcbd199b661",
"md5": "24b3dd6aed4adc26d4f7f13ffbb7a96e",
"sha256": "4b920b8acc5fcdf706f9478eafe5fe8d55ad44875f6f3480b0a225dd93bee224"
},
"downloads": -1,
"filename": "commitlint-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "24b3dd6aed4adc26d4f7f13ffbb7a96e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21245,
"upload_time": "2024-02-01T12:35:22",
"upload_time_iso_8601": "2024-02-01T12:35:22.288795Z",
"url": "https://files.pythonhosted.org/packages/2e/57/be3e74525064e0c6e10d1d7747a62079c2547eab657279bf0bcbd199b661/commitlint-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-01 12:35:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opensource-nepal",
"github_project": "commitlint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "commitlint"
}
JSON
