| Name | committed JSON |
| Version |
1.1.5
JSON |
| download |
| home_page | None |
| Summary | Nitpicking commit history since beabf39 |
| upload_time | 2024-12-19 03:29:10 |
| 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`**
[](https://codecov.io/gh/crate-ci/committed)
[][Documentation]
[][Crates.io]
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.1.5
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 a GitHub Actions
example](https://github.com/crate-ci/imperative/blob/master/.github/workflows/committed.yml)
or look at `committed`s own [GitHub Actions pipeline](.github/workflows/committed.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/01/70/5c55757dbaccb1784a749d3814952b8a6538fc633490b392c0917b40e568/committed-1.1.5.tar.gz",
"platform": null,
"description": "# committed\n\n> **Nitpicking commit history since `beabf39`**\n\n[](https://codecov.io/gh/crate-ci/committed)\n[][Documentation]\n\n[][Crates.io]\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.1.5\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 a GitHub Actions\nexample](https://github.com/crate-ci/imperative/blob/master/.github/workflows/committed.yml)\nor look at `committed`s own [GitHub Actions pipeline](.github/workflows/committed.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.1.5",
"project_urls": {
"Source Code": "https://github.com/crate-ci/committed"
},
"split_keywords": [
"development"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dc53f84117cab28866593f57cf8173dd41d60513f6dc57051098f6203d55ee96",
"md5": "c0db4c5acc227b76bac1f4518465537e",
"sha256": "6df4c0bbf6b23cc356626a8595221e3ec3878c300b0708de7583e83939f5ecb5"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "c0db4c5acc227b76bac1f4518465537e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1482788,
"upload_time": "2024-12-19T03:28:44",
"upload_time_iso_8601": "2024-12-19T03:28:44.937232Z",
"url": "https://files.pythonhosted.org/packages/dc/53/f84117cab28866593f57cf8173dd41d60513f6dc57051098f6203d55ee96/committed-1.1.5-py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "63a44954835c7a01c749b7969d3eb1ba5202b71d12580c013aeb76cdcb7bd64f",
"md5": "3cc378027c18c19b2105479114cfec65",
"sha256": "ee8c94da471e3d5adf7877fe240102331a0dc69e209493bb6d111541fed994b4"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "3cc378027c18c19b2105479114cfec65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1362267,
"upload_time": "2024-12-19T03:28:46",
"upload_time_iso_8601": "2024-12-19T03:28:46.847883Z",
"url": "https://files.pythonhosted.org/packages/63/a4/4954835c7a01c749b7969d3eb1ba5202b71d12580c013aeb76cdcb7bd64f/committed-1.1.5-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c036724d67199edc359ed32b02fd06488de6bdbff20666349ede199a3cd94c54",
"md5": "ae18944917e094c5e1c2e711b58414f2",
"sha256": "7a50d4c1156550fe599179df0639413c1728e6053fab4b2ee5f525de19659d17"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "ae18944917e094c5e1c2e711b58414f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1546933,
"upload_time": "2024-12-19T03:28:50",
"upload_time_iso_8601": "2024-12-19T03:28:50.024638Z",
"url": "https://files.pythonhosted.org/packages/c0/36/724d67199edc359ed32b02fd06488de6bdbff20666349ede199a3cd94c54/committed-1.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "004525af852f8525b130a65e4ce440fd4a79403968f58b08051f375ffaa8e146",
"md5": "2ead01004f009784997ad753b3f7d732",
"sha256": "753c0b32d7a40dab08a93be16f612dfea9b23db97b43318bb656b9d39ead87a2"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "2ead01004f009784997ad753b3f7d732",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1653902,
"upload_time": "2024-12-19T03:28:51",
"upload_time_iso_8601": "2024-12-19T03:28:51.401954Z",
"url": "https://files.pythonhosted.org/packages/00/45/25af852f8525b130a65e4ce440fd4a79403968f58b08051f375ffaa8e146/committed-1.1.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "422e69724631695e6a86e433ae8e8dcf2af73206544df5580f2f950daa594952",
"md5": "17fe09765d568d91c9de803f7dbf3777",
"sha256": "68523f9076409a40b649362a836c929d789451bd0b89d023d59b25452ba75cf5"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "17fe09765d568d91c9de803f7dbf3777",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1625684,
"upload_time": "2024-12-19T03:28:54",
"upload_time_iso_8601": "2024-12-19T03:28:54.466200Z",
"url": "https://files.pythonhosted.org/packages/42/2e/69724631695e6a86e433ae8e8dcf2af73206544df5580f2f950daa594952/committed-1.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "89f6d33be76ac8bd3035257045df63be50b199dab9ba817e8681904d083d55a7",
"md5": "7fe8f19c9f76643d1538b330865423c3",
"sha256": "90341cc9ace2386f0c63335ce7243ab6fcc7edde7e3a6506c31403289a542646"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-musllinux_1_2_aarch64.whl",
"has_sig": false,
"md5_digest": "7fe8f19c9f76643d1538b330865423c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1597761,
"upload_time": "2024-12-19T03:28:57",
"upload_time_iso_8601": "2024-12-19T03:28:57.171572Z",
"url": "https://files.pythonhosted.org/packages/89/f6/d33be76ac8bd3035257045df63be50b199dab9ba817e8681904d083d55a7/committed-1.1.5-py3-none-musllinux_1_2_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b3fa8a5ead969d5bd35ec6325fe4278a25fdbf13b930d20c438da0e9e393c4aa",
"md5": "b6d8b78902c472647a9d05c20f91475e",
"sha256": "cb70b0d00f307e4f693a7572fb9b65eebc960c04847ed698fcc1cf64ced774d1"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "b6d8b78902c472647a9d05c20f91475e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1723446,
"upload_time": "2024-12-19T03:28:58",
"upload_time_iso_8601": "2024-12-19T03:28:58.681988Z",
"url": "https://files.pythonhosted.org/packages/b3/fa/8a5ead969d5bd35ec6325fe4278a25fdbf13b930d20c438da0e9e393c4aa/committed-1.1.5-py3-none-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cdb2793f9ba42ee64de99de934d5e8d2bc7492fec2de7b697aa929a2655f7ddd",
"md5": "8c01fa52449d1741bc45b9e1ec514f5b",
"sha256": "c0f517b314ac097233db16d8e08fdd8612c8046f3d13e5ac7eabf7138ab7fc2c"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "8c01fa52449d1741bc45b9e1ec514f5b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1497954,
"upload_time": "2024-12-19T03:29:01",
"upload_time_iso_8601": "2024-12-19T03:29:01.879931Z",
"url": "https://files.pythonhosted.org/packages/cd/b2/793f9ba42ee64de99de934d5e8d2bc7492fec2de7b697aa929a2655f7ddd/committed-1.1.5-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d0fba05390cf8a5b86a594ca05ee4f9441de8a8cc2a277c43739efdde3b4d330",
"md5": "8f089657cc1f0cb1225f1ed6526c5523",
"sha256": "7fca753eda1ab9a6e82ecb0cbeefa51cb6224082b1c6552b05f25fd5c1c2ac1c"
},
"downloads": -1,
"filename": "committed-1.1.5-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "8f089657cc1f0cb1225f1ed6526c5523",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1646657,
"upload_time": "2024-12-19T03:29:07",
"upload_time_iso_8601": "2024-12-19T03:29:07.069106Z",
"url": "https://files.pythonhosted.org/packages/d0/fb/a05390cf8a5b86a594ca05ee4f9441de8a8cc2a277c43739efdde3b4d330/committed-1.1.5-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "01705c55757dbaccb1784a749d3814952b8a6538fc633490b392c0917b40e568",
"md5": "55d587cecbbf6283ad1120eb95993df0",
"sha256": "49ea79c258cabb028d6f7497eeba3642fec3f526c3762efd8d8dcd16312b74c3"
},
"downloads": -1,
"filename": "committed-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "55d587cecbbf6283ad1120eb95993df0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 22783,
"upload_time": "2024-12-19T03:29:10",
"upload_time_iso_8601": "2024-12-19T03:29:10.978319Z",
"url": "https://files.pythonhosted.org/packages/01/70/5c55757dbaccb1784a749d3814952b8a6538fc633490b392c0917b40e568/committed-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 03:29:10",
"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"
}
