<p align="center">
<a href="https://git-cliff.org">
<img src="https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-logo.png" width="300"></a>
<br>
<a href="https://github.com/orhun/git-cliff/releases">
<img src="https://img.shields.io/github/v/release/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=GitHub&logoColor=white">
</a>
<a href="https://crates.io/crates/git-cliff/">
<img src="https://img.shields.io/crates/v/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Rust&logoColor=white">
</a>
<a href="https://codecov.io/gh/orhun/git-cliff">
<img src="https://img.shields.io/codecov/c/gh/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Codecov&logoColor=white">
</a>
<br>
<a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Integration%22">
<img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/ci.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9">
</a>
<a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Deployment%22">
<img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/cd.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9&label=deploy">
</a>
<a href="https://hub.docker.com/r/orhunp/git-cliff">
<img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/docker.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&label=docker&logo=Docker&logoColor=BEC5C9">
</a>
<a href="https://docs.rs/git-cliff-core/">
<img src="https://img.shields.io/docsrs/git-cliff-core?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=Rust&logoColor=BEC5C9">
</a>
<br>
<a href="https://matrix.to/#/#git-cliff:matrix.org">
<img src="https://img.shields.io/matrix/git-cliff:matrix.org?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=matrix&logoColor=BEC5C9&label=join%20matrix">
</a>
<a href="https://discord.gg/W3mAwMDWH4">
<img src="https://img.shields.io/discord/1093977388892819553?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=discord&logoColor=BEC5C9&label=join%20discord">
</a>
</p>
<h4 align="center">
<a href="https://git-cliff.org/docs">Documentation</a> |
<a href="https://git-cliff.org">Website</a>
</h4>
**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration/git#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.
## Documentation
Learn how to use **git-cliff** from the [documentation](https://git-cliff.org/docs).
- [Installation](https://git-cliff.org/docs/installation/)
- [Usage](https://git-cliff.org/docs/usage/examples)
- [Configuration](https://git-cliff.org/docs/configuration)
- [Templating](https://git-cliff.org/docs/category/templating)
## In The Media
- [Turning Git commits into changelog with git-cliff](https://www.youtube.com/watch?v=RWh8qbiLRts) - RustLab 2023 (Talk)
- [An Interview with Orhun of git-cliff](https://console.substack.com/p/console-141) - Console #141 (Newsletter)
## Editor Support
- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Generate, update and release changelog in Emacs
## Similar/Related Projects
- [git-journal](https://github.com/saschagrunert/git-journal) - The Git Commit Message and Changelog Generation Framework
- [clog-cli](https://github.com/clog-tool/clog-cli) - Generate beautiful changelogs from your Git commit history
- [relnotes](https://crates.io/crates/relnotes) - A tool to automatically generate release notes for your project.
- [cocogitto](https://github.com/oknozor/cocogitto) - A set of CLI tools for the conventional commit and semver specifications.
- [cliff-jumper](https://github.com/favware/cliff-jumper) - A NodeJS CLI tool that combines git-cliff and
[conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump)
to semantically bump a NodeJS package and generate a git-cliff powered changelog.
- [release-plz](https://github.com/MarcoIeni/release-plz) - Release Rust packages from CI.
- [git-changelog-command-line](https://github.com/tomasbjerre/git-changelog-command-line) - Generate changelog and determine next version with conventional commits.
## Contributors
Thanks goes to these wonderful people ✨
<a href="https://github.com/orhun/git-cliff/graphs/contributors">
<img src="https://contrib.rocks/image?repo=orhun/git-cliff" />
</a>
Made with [contrib.rocks](https://contrib.rocks).
## License
Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.
## Copyright
Copyright © 2021-2024, [git-cliff contributors](mailto:git-cliff@protonmail.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/orhun/git-cliff",
"name": "git-cliff",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "changelog, generator, conventional, commit",
"author": "git-cliff contributors <git-cliff@protonmail.com>",
"author_email": "git-cliff contributors <git-cliff@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ac/bd/3bc9cd4ed7d6e2db7d51f531e3e167f1d9ce308ef137f980cda7ebed1f83/git_cliff-2.2.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://git-cliff.org\">\n <img src=\"https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-logo.png\" width=\"300\"></a>\n <br>\n <a href=\"https://github.com/orhun/git-cliff/releases\">\n <img src=\"https://img.shields.io/github/v/release/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=GitHub&logoColor=white\">\n </a>\n <a href=\"https://crates.io/crates/git-cliff/\">\n <img src=\"https://img.shields.io/crates/v/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Rust&logoColor=white\">\n </a>\n <a href=\"https://codecov.io/gh/orhun/git-cliff\">\n <img src=\"https://img.shields.io/codecov/c/gh/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Codecov&logoColor=white\">\n </a>\n <br>\n <a href=\"https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Integration%22\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/ci.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9\">\n </a>\n <a href=\"https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Deployment%22\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/cd.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9&label=deploy\">\n </a>\n <a href=\"https://hub.docker.com/r/orhunp/git-cliff\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/docker.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&label=docker&logo=Docker&logoColor=BEC5C9\">\n </a>\n <a href=\"https://docs.rs/git-cliff-core/\">\n <img src=\"https://img.shields.io/docsrs/git-cliff-core?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=Rust&logoColor=BEC5C9\">\n </a>\n <br>\n <a href=\"https://matrix.to/#/#git-cliff:matrix.org\">\n <img src=\"https://img.shields.io/matrix/git-cliff:matrix.org?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=matrix&logoColor=BEC5C9&label=join%20matrix\">\n </a>\n <a href=\"https://discord.gg/W3mAwMDWH4\">\n <img src=\"https://img.shields.io/discord/1093977388892819553?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=discord&logoColor=BEC5C9&label=join%20discord\">\n </a>\n</p>\n\n<h4 align=\"center\">\n <a href=\"https://git-cliff.org/docs\">Documentation</a> |\n <a href=\"https://git-cliff.org\">Website</a>\n</h4>\n\n**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration/git#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.\n\n\n\n## Documentation\n\nLearn how to use **git-cliff** from the [documentation](https://git-cliff.org/docs).\n\n- [Installation](https://git-cliff.org/docs/installation/)\n- [Usage](https://git-cliff.org/docs/usage/examples)\n- [Configuration](https://git-cliff.org/docs/configuration)\n- [Templating](https://git-cliff.org/docs/category/templating)\n\n## In The Media\n\n- [Turning Git commits into changelog with git-cliff](https://www.youtube.com/watch?v=RWh8qbiLRts) - RustLab 2023 (Talk)\n- [An Interview with Orhun of git-cliff](https://console.substack.com/p/console-141) - Console #141 (Newsletter)\n\n## Editor Support\n\n- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Generate, update and release changelog in Emacs\n\n## Similar/Related Projects\n\n- [git-journal](https://github.com/saschagrunert/git-journal) - The Git Commit Message and Changelog Generation Framework\n- [clog-cli](https://github.com/clog-tool/clog-cli) - Generate beautiful changelogs from your Git commit history\n- [relnotes](https://crates.io/crates/relnotes) - A tool to automatically generate release notes for your project.\n- [cocogitto](https://github.com/oknozor/cocogitto) - A set of CLI tools for the conventional commit and semver specifications.\n- [cliff-jumper](https://github.com/favware/cliff-jumper) - A NodeJS CLI tool that combines git-cliff and\n [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump)\n to semantically bump a NodeJS package and generate a git-cliff powered changelog.\n- [release-plz](https://github.com/MarcoIeni/release-plz) - Release Rust packages from CI.\n- [git-changelog-command-line](https://github.com/tomasbjerre/git-changelog-command-line) - Generate changelog and determine next version with conventional commits.\n\n## Contributors\n\nThanks goes to these wonderful people \u2728\n\n<a href=\"https://github.com/orhun/git-cliff/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=orhun/git-cliff\" />\n</a>\n\nMade with [contrib.rocks](https://contrib.rocks).\n\n## License\n\nLicensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.\n\n## Copyright\n\nCopyright \u00a9 2021-2024, [git-cliff contributors](mailto:git-cliff@protonmail.com)\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "A highly customizable changelog generator \u26f0\ufe0f",
"version": "2.2.1",
"project_urls": {
"Homepage": "https://github.com/orhun/git-cliff",
"Source Code": "https://github.com/orhun/git-cliff"
},
"split_keywords": [
"changelog",
" generator",
" conventional",
" commit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "24ec43fc5b5b80cff1ad0da8effd354d99366b23e787c0b7789abb905e9a5cd1",
"md5": "58e72ec2120d5a367f3792ac12b3229d",
"sha256": "f7c6550733a60e135f821ac999ee6804f185089ae6b7bb4f91dad32a8d95a2d5"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "58e72ec2120d5a367f3792ac12b3229d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6160670,
"upload_time": "2024-04-10T22:48:06",
"upload_time_iso_8601": "2024-04-10T22:48:06.235417Z",
"url": "https://files.pythonhosted.org/packages/24/ec/43fc5b5b80cff1ad0da8effd354d99366b23e787c0b7789abb905e9a5cd1/git_cliff-2.2.1-py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "139673185bbf4e5e9fbe23974b18b99680640e7d87383d34fc694dacf36805c4",
"md5": "fdd1b7cbddfc4aed78e3c7a16e1c9626",
"sha256": "e624814e9273f8a4000fb7425842a7c062631234a84092a9d551f24520c956db"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "fdd1b7cbddfc4aed78e3c7a16e1c9626",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5802302,
"upload_time": "2024-04-10T22:48:08",
"upload_time_iso_8601": "2024-04-10T22:48:08.310064Z",
"url": "https://files.pythonhosted.org/packages/13/96/73185bbf4e5e9fbe23974b18b99680640e7d87383d34fc694dacf36805c4/git_cliff-2.2.1-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0a15d09b019b55ffa5370cad9c1360eaeb830ef42ec1de985e9e05d004303c3b",
"md5": "c1a1b0fe0911099df2ee517f6f4599f3",
"sha256": "548c994d902e74e2e104e4603ac29419020d3d54eaf5ce3b8e17e77493448faf"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "c1a1b0fe0911099df2ee517f6f4599f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6125046,
"upload_time": "2024-04-10T22:48:10",
"upload_time_iso_8601": "2024-04-10T22:48:10.323277Z",
"url": "https://files.pythonhosted.org/packages/0a/15/d09b019b55ffa5370cad9c1360eaeb830ef42ec1de985e9e05d004303c3b/git_cliff-2.2.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "04d119490254ac334f46cd258e99e7a9d7cb5d7b1968f89bc8cce8b4fb0c6f6d",
"md5": "426f60e991f00ecfc51ba8b9bad6cbe2",
"sha256": "739447e3c22c7aa964f0900b4f63234a5ff8246988797a70f3245fc37cebf1b5"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "426f60e991f00ecfc51ba8b9bad6cbe2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6580652,
"upload_time": "2024-04-10T22:48:13",
"upload_time_iso_8601": "2024-04-10T22:48:13.495053Z",
"url": "https://files.pythonhosted.org/packages/04/d1/19490254ac334f46cd258e99e7a9d7cb5d7b1968f89bc8cce8b4fb0c6f6d/git_cliff-2.2.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "aa74276eb0c5f576c2f87b999969a9b1cc4ad7e07a49a1490091029dfc1fe3ab",
"md5": "15ae798ee84b0fcb7b4c33e6298f52c7",
"sha256": "aea2aa2250b5fff738294e7eee1c458ba4dadc81fc823d31f29eb1c689ee09d0"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-manylinux_2_28_aarch64.whl",
"has_sig": false,
"md5_digest": "15ae798ee84b0fcb7b4c33e6298f52c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6185639,
"upload_time": "2024-04-10T22:48:15",
"upload_time_iso_8601": "2024-04-10T22:48:15.966305Z",
"url": "https://files.pythonhosted.org/packages/aa/74/276eb0c5f576c2f87b999969a9b1cc4ad7e07a49a1490091029dfc1fe3ab/git_cliff-2.2.1-py3-none-manylinux_2_28_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a3e620dcd1497aa06e69a0b2f22328eca3959fcc1b67c3cb04cdced5b3d9fd48",
"md5": "8bf31407410e5e27d67ed55b12817d41",
"sha256": "0645822f4ff4aaf68e7fa61fd31a583ccef9793a71b0a34c50c9fac43d90a254"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
"has_sig": false,
"md5_digest": "8bf31407410e5e27d67ed55b12817d41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6298870,
"upload_time": "2024-04-10T22:48:18",
"upload_time_iso_8601": "2024-04-10T22:48:18.660868Z",
"url": "https://files.pythonhosted.org/packages/a3/e6/20dcd1497aa06e69a0b2f22328eca3959fcc1b67c3cb04cdced5b3d9fd48/git_cliff-2.2.1-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "944b214609269e4d2885e38f6ba57beaeebdfb204718d7cacd6770833d34a728",
"md5": "978472f85c3bd457895aa577d23a3653",
"sha256": "01a02869e3b186f173d1f14db11f7c7130394195fc6e352ac0e3cd505d65104f"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"has_sig": false,
"md5_digest": "978472f85c3bd457895aa577d23a3653",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6790707,
"upload_time": "2024-04-10T22:48:22",
"upload_time_iso_8601": "2024-04-10T22:48:22.244334Z",
"url": "https://files.pythonhosted.org/packages/94/4b/214609269e4d2885e38f6ba57beaeebdfb204718d7cacd6770833d34a728/git_cliff-2.2.1-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "64e0dfa084391851288646417c6df3eec0f6a486dec565c6b1afe93fc4825af0",
"md5": "6ac79c69037f7bd987fed38546289c35",
"sha256": "e98bf87ee7b22eacdba0e74016f93b6d6d1fea6cb2cf67742c3aaa1614fafef9"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "6ac79c69037f7bd987fed38546289c35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5849164,
"upload_time": "2024-04-10T22:48:25",
"upload_time_iso_8601": "2024-04-10T22:48:25.642055Z",
"url": "https://files.pythonhosted.org/packages/64/e0/dfa084391851288646417c6df3eec0f6a486dec565c6b1afe93fc4825af0/git_cliff-2.2.1-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9a3485f11be7a52ea5cf510c9bf8d72a50712aab210a678deb7fd1f9c20a058f",
"md5": "a606622bf13da6f14fc2998dff4d2f14",
"sha256": "e57155dbb3a895c09ed358137d0d1d30d3f15971456f3c48ede9bfd37434ce75"
},
"downloads": -1,
"filename": "git_cliff-2.2.1-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "a606622bf13da6f14fc2998dff4d2f14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6612928,
"upload_time": "2024-04-10T22:48:27",
"upload_time_iso_8601": "2024-04-10T22:48:27.762640Z",
"url": "https://files.pythonhosted.org/packages/9a/34/85f11be7a52ea5cf510c9bf8d72a50712aab210a678deb7fd1f9c20a058f/git_cliff-2.2.1-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "acbd3bc9cd4ed7d6e2db7d51f531e3e167f1d9ce308ef137f980cda7ebed1f83",
"md5": "ccafba0022b5ba288802e7c483188793",
"sha256": "6db64534dc5ec3d7656b9be6ddf7004cfd1ddf8f815f66d41bc9330f42b61d6d"
},
"downloads": -1,
"filename": "git_cliff-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ccafba0022b5ba288802e7c483188793",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60421,
"upload_time": "2024-04-10T22:48:30",
"upload_time_iso_8601": "2024-04-10T22:48:30.943463Z",
"url": "https://files.pythonhosted.org/packages/ac/bd/3bc9cd4ed7d6e2db7d51f531e3e167f1d9ce308ef137f980cda7ebed1f83/git_cliff-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 22:48:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "orhun",
"github_project": "git-cliff",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-cliff"
}
JSON
