Name | committed JSON |
Version |
1.0.20
JSON |
| download |
home_page | None |
Summary | Nitpicking commit history since beabf39 |
upload_time | 2023-08-07 21:41:52 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.7 |
license | MIT OR Apache-2.0 |
keywords |
development
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
|
coveralls test coverage |
No coveralls.
|
# committed
> **Nitpicking commit history since `beabf39`**
[![codecov](https://codecov.io/gh/crate-ci/committed/branch/master/graph/badge.svg)](https://codecov.io/gh/crate-ci/committed)
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
![License](https://img.shields.io/crates/l/committed.svg)
[![Crates Status](https://img.shields.io/crates/v/committed.svg)](https://crates.io/crates/committed)
Enforce commit standards, whether for:
- Readability, especially in logs
- Consistent styling
- Compatibility with programmatic processing
## Install
[Download](https://github.com/crate-ci/committed/releases) a pre-built binary
(installable via [gh-install](https://github.com/crate-ci/gh-install).
Or use rust to install:
```bash
cargo install committed
```
### pre-commit
To use `committed` with [`pre-commit`](https://pre-commit.com), point its
config at this repository:
```yaml
repos:
- repo: https://github.com/crate-ci/committed
rev: v1.0.20
hooks:
- id: committed
```
The `committed` id installs a prebuilt executable from GitHub releases. If
one does not exist for the target platform, or if one built from
sources is preferred, use `committed-src` as the hook id instead.
Be sure to change `rev` to use the desired `committed` git tag or
revision.
The hook, by default, will verify your commit message.
## Basic Usage
Verify your latest commit
```bash
committed HEAD
```
Verify your branch
```bash
committed master..HEAD --no-merge-commit
```
Have your CI verify your PR (assuming it does a no-ff merge into your `master`)
```bash
committed HEAD~..HEAD^2 --no-merge-commit
```
See [`imperative` for an Azure Pipeline
example](https://github.com/crate-ci/imperative/blob/master/azure-pipelines.yml)
or look at `committed`s own [`azure-pipelines.yml`](azure-pipelines.yml),
[`.travis.yml`](.travis.yml), or [`appveyor.yml`](appveyor.yml).
## [Reference](docs/reference.md)
## [Contribute](CONTRIBUTING.md)
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
[Crates.io]: https://crates.io/crates/committed
[Documentation]: https://docs.rs/committed
Raw data
{
"_id": null,
"home_page": null,
"name": "committed",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "development",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8c/4a/54128a50fb7ba61c70ee3382d2c085b45b1f370501e8fa5224bd7463c83c/committed-1.0.20.tar.gz",
"platform": null,
"description": "# committed\n\n> **Nitpicking commit history since `beabf39`**\n\n[![codecov](https://codecov.io/gh/crate-ci/committed/branch/master/graph/badge.svg)](https://codecov.io/gh/crate-ci/committed)\n[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]\n![License](https://img.shields.io/crates/l/committed.svg)\n[![Crates Status](https://img.shields.io/crates/v/committed.svg)](https://crates.io/crates/committed)\n\nEnforce commit standards, whether for:\n- Readability, especially in logs\n- Consistent styling\n- Compatibility with programmatic processing\n\n## Install\n\n[Download](https://github.com/crate-ci/committed/releases) a pre-built binary\n(installable via [gh-install](https://github.com/crate-ci/gh-install).\n\nOr use rust to install:\n```bash\ncargo install committed\n```\n\n### pre-commit\n\nTo use `committed` with [`pre-commit`](https://pre-commit.com), point its\nconfig at this repository:\n\n```yaml\nrepos:\n - repo: https://github.com/crate-ci/committed\n rev: v1.0.20\n hooks:\n - id: committed\n```\n\nThe `committed` id installs a prebuilt executable from GitHub releases. If\none does not exist for the target platform, or if one built from\nsources is preferred, use `committed-src` as the hook id instead.\n\nBe sure to change `rev` to use the desired `committed` git tag or\nrevision.\n\nThe hook, by default, will verify your commit message.\n\n## Basic Usage\n\nVerify your latest commit\n```bash\ncommitted HEAD\n```\n\nVerify your branch\n```bash\ncommitted master..HEAD --no-merge-commit\n```\n\nHave your CI verify your PR (assuming it does a no-ff merge into your `master`)\n```bash\ncommitted HEAD~..HEAD^2 --no-merge-commit\n```\nSee [`imperative` for an Azure Pipeline\nexample](https://github.com/crate-ci/imperative/blob/master/azure-pipelines.yml)\nor look at `committed`s own [`azure-pipelines.yml`](azure-pipelines.yml),\n[`.travis.yml`](.travis.yml), or [`appveyor.yml`](appveyor.yml).\n\n## [Reference](docs/reference.md)\n\n## [Contribute](CONTRIBUTING.md)\n\n## License\n\nLicensed under either of\n\n * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n[Crates.io]: https://crates.io/crates/committed\n[Documentation]: https://docs.rs/committed\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "Nitpicking commit history since beabf39",
"version": "1.0.20",
"project_urls": {
"Source Code": "https://github.com/crate-ci/committed"
},
"split_keywords": [
"development"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fa3b33028a98f98b7cf0a72c2cb075416cbff24b36581e593322652e987df17d",
"md5": "b1c77153145343064bab8144f8a0ec54",
"sha256": "a19353cfc87ecc3afc1ccc85ad0c004acfcaad0452fa3b0f3c2c89a88736b1a4"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "b1c77153145343064bab8144f8a0ec54",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1834341,
"upload_time": "2023-08-07T21:41:31",
"upload_time_iso_8601": "2023-08-07T21:41:31.493349Z",
"url": "https://files.pythonhosted.org/packages/fa/3b/33028a98f98b7cf0a72c2cb075416cbff24b36581e593322652e987df17d/committed-1.0.20-py3-none-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "41fbf60e7511914c883e3bd2f7987a1f24ceaffa3a13a0c356b73b3cbe5334c9",
"md5": "da3a69dbd7117b25596558ce5562d830",
"sha256": "6c007fbf6607851ffd29d4c11497c30a28c3799bd8dd8c5c3cbfa2e17040c5fc"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "da3a69dbd7117b25596558ce5562d830",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1721599,
"upload_time": "2023-08-07T21:41:34",
"upload_time_iso_8601": "2023-08-07T21:41:34.120886Z",
"url": "https://files.pythonhosted.org/packages/41/fb/f60e7511914c883e3bd2f7987a1f24ceaffa3a13a0c356b73b3cbe5334c9/committed-1.0.20-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9ae5a7f5d043de4022937871d064d517996fd38c59236a667a07cad64c27a527",
"md5": "980ac41fa99baf9986568f3fa8c2f6e8",
"sha256": "8515baf51fe65912d5a926a1ccc1a2f1b5a2ab71bed0e224611d40e035684061"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "980ac41fa99baf9986568f3fa8c2f6e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2870247,
"upload_time": "2023-08-07T21:41:36",
"upload_time_iso_8601": "2023-08-07T21:41:36.636915Z",
"url": "https://files.pythonhosted.org/packages/9a/e5/a7f5d043de4022937871d064d517996fd38c59236a667a07cad64c27a527/committed-1.0.20-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c181d87a017c878329de66cd51ae905aafe24b455d7e56e6dfa1de78534da326",
"md5": "aecf721abe6a2e280d28f19d4b0f7977",
"sha256": "5edf2d375531cf12213bab7a08ec79bed12a177287375984c7909a36dc1b1b5f"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "aecf721abe6a2e280d28f19d4b0f7977",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2980229,
"upload_time": "2023-08-07T21:41:38",
"upload_time_iso_8601": "2023-08-07T21:41:38.867658Z",
"url": "https://files.pythonhosted.org/packages/c1/81/d87a017c878329de66cd51ae905aafe24b455d7e56e6dfa1de78534da326/committed-1.0.20-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "52f33104838afe6b25f9ab718e3e48af6e054455433168e1a8268b9bd9cec2a0",
"md5": "9510a995d08f4caa9bd58c0ed0b476b7",
"sha256": "5eee933a062241f3e798420d0dc6ed070f7cc0b40cba3acf99cd643f8e675fd7"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "9510a995d08f4caa9bd58c0ed0b476b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2870028,
"upload_time": "2023-08-07T21:41:41",
"upload_time_iso_8601": "2023-08-07T21:41:41.007424Z",
"url": "https://files.pythonhosted.org/packages/52/f3/3104838afe6b25f9ab718e3e48af6e054455433168e1a8268b9bd9cec2a0/committed-1.0.20-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9d62558dc2fe80299ee674d5d9c6c27cc4abb3bc05195cd48ff867efa20ebe0e",
"md5": "93b2a5945970dc9c9700f56fb10fd2f5",
"sha256": "0c6c060ccc42c51805b50fa21e8283ab63927a298325af7ecf6694d892d349a1"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-musllinux_1_2_aarch64.whl",
"has_sig": false,
"md5_digest": "93b2a5945970dc9c9700f56fb10fd2f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2974744,
"upload_time": "2023-08-07T21:41:43",
"upload_time_iso_8601": "2023-08-07T21:41:43.093644Z",
"url": "https://files.pythonhosted.org/packages/9d/62/558dc2fe80299ee674d5d9c6c27cc4abb3bc05195cd48ff867efa20ebe0e/committed-1.0.20-py3-none-musllinux_1_2_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "84aeff15fd44e7f736481866f608b3517c789c168cd0d4b1c7d70fe6e86b3ef4",
"md5": "9a3c49c1ea09d4b0c9f7f21e81e37efe",
"sha256": "5cdb6c008f79ba340be0a9e781b3f97af4df15109401109be7ae4163be10c2ac"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "9a3c49c1ea09d4b0c9f7f21e81e37efe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3017943,
"upload_time": "2023-08-07T21:41:45",
"upload_time_iso_8601": "2023-08-07T21:41:45.248707Z",
"url": "https://files.pythonhosted.org/packages/84/ae/ff15fd44e7f736481866f608b3517c789c168cd0d4b1c7d70fe6e86b3ef4/committed-1.0.20-py3-none-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0bacc155595613e3e2b5960b435b7f373a8c049a5ea3b7d0e582e42f3aec02c4",
"md5": "5cc825997f978577ee25ab5cbe3a00b7",
"sha256": "36da852b0d606c8746afc3c750c424df5342e19feca0280c738863571259c670"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "5cc825997f978577ee25ab5cbe3a00b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1664158,
"upload_time": "2023-08-07T21:41:47",
"upload_time_iso_8601": "2023-08-07T21:41:47.993891Z",
"url": "https://files.pythonhosted.org/packages/0b/ac/c155595613e3e2b5960b435b7f373a8c049a5ea3b7d0e582e42f3aec02c4/committed-1.0.20-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "749cb04eb0f795b6dcf601a1d03301c34b783eb717d5a85d4f90ecdc093d739e",
"md5": "5d17e2b649dd03f8559c46fc2d3f8ed9",
"sha256": "2b365ac43cbb135ea8ec44217f937e6f591f40299fe28133fc3591acfa9e8387"
},
"downloads": -1,
"filename": "committed-1.0.20-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "5d17e2b649dd03f8559c46fc2d3f8ed9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1853990,
"upload_time": "2023-08-07T21:41:50",
"upload_time_iso_8601": "2023-08-07T21:41:50.118028Z",
"url": "https://files.pythonhosted.org/packages/74/9c/b04eb0f795b6dcf601a1d03301c34b783eb717d5a85d4f90ecdc093d739e/committed-1.0.20-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8c4a54128a50fb7ba61c70ee3382d2c085b45b1f370501e8fa5224bd7463c83c",
"md5": "8fe969267cd6272005e49a9510782fea",
"sha256": "f243a2c9742426561fb4c4c7d0e4d941a593b9f50e0acd245f382db198bee89e"
},
"downloads": -1,
"filename": "committed-1.0.20.tar.gz",
"has_sig": false,
"md5_digest": "8fe969267cd6272005e49a9510782fea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19733,
"upload_time": "2023-08-07T21:41:52",
"upload_time_iso_8601": "2023-08-07T21:41:52.149703Z",
"url": "https://files.pythonhosted.org/packages/8c/4a/54128a50fb7ba61c70ee3382d2c085b45b1f370501e8fa5224bd7463c83c/committed-1.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-07 21:41:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crate-ci",
"github_project": "committed",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "committed"
}