2021-06-13 02:14:27 +03:00
< p align = "center" >
2023-04-09 18:08:59 +03:00
< a href = "https://git-cliff.org" >
2021-06-13 02:14:27 +03:00
< img src = "https://user-images.githubusercontent.com/24392180/121790699-8808dc80-cbea-11eb-8ab6-2fb6b08b66d8.png" width = "300" > < / a >
< br >
2021-07-14 21:53:00 +03:00
< 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" >
2022-12-25 21:04:57 +03:00
< 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" >
2021-07-14 21:53:00 +03:00
< / a >
< a href = "https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Deployment%22" >
2022-12-25 21:04:57 +03:00
< 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" >
2021-07-14 21:53:00 +03:00
< / a >
< a href = "https://hub.docker.com/r/orhunp/git-cliff" >
2022-12-25 21:04:57 +03:00
< 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" >
2021-07-14 21:53:00 +03:00
< / a >
< a href = "https://docs.rs/git-cliff-core/" >
2023-04-07 22:33:57 +03:00
< img src = "https://img.shields.io/docsrs/git-cliff-core?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=Rust&logoColor=BEC5C9" >
2021-07-14 21:53:00 +03:00
< / a >
2021-09-08 14:20:45 +03:00
< br >
< a href = "https://matrix.to/#/#git-cliff:matrix.org" >
2023-04-07 22:33:57 +03:00
< 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" >
2021-09-08 14:20:45 +03:00
< / a >
2021-06-13 02:14:27 +03:00
< / p >
2023-04-09 19:01:29 +03:00
< h4 align = "center" >
< a href = "https://git-cliff.org/docs" > Documentation< / a > |
< a href = "https://git-cliff.org" > Website< / a >
< / h4 >
2021-07-14 21:38:53 +03:00
2023-04-09 19:01:29 +03:00
**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#conventional_commits ) as well as regex-powered [custom parsers ](https://git-cliff.org/docs/configuration#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.
2021-07-14 21:38:53 +03:00
2021-08-08 22:23:13 +03:00
![preview ](https://user-images.githubusercontent.com/24392180/128637997-5713ba25-d8f3-40c7-8ba8-ea7f333ead88.png )
2023-04-09 18:08:59 +03:00
## Documentation
2021-07-14 22:49:22 +03:00
2023-04-09 19:01:29 +03:00
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 )
2021-12-11 15:07:10 +03:00
2023-01-22 21:27:31 +03:00
## In The Media
2023-04-10 05:34:17 +03:00
- **git-cliff** was featured in [Console #141 - The Open Source Newsletter ](https://console.substack.com/p/console-141 )
2023-01-22 21:27:31 +03:00
2022-04-24 14:00:00 +03:00
## Similar/Related Projects
2021-07-14 21:38:53 +03:00
2021-07-18 19:00:02 +03:00
- [git-journal ](https://github.com/saschagrunert/git-journal ) - The Git Commit Message and Changelog Generation Framework
2021-07-14 21:38:53 +03:00
- [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.
2023-04-04 22:56:49 +03:00
- [cocogitto ](https://github.com/oknozor/cocogitto ) - A set of CLI tools for the conventional commit and semver specifications.
2022-04-18 22:32:40 +03:00
- [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.
2023-04-07 04:33:34 +03:00
- [release-plz ](https://github.com/MarcoIeni/release-plz ) - Release Rust packages from CI.
2021-06-16 22:42:54 +03:00
2021-06-13 02:14:27 +03:00
## License
GNU General Public License ([v3.0](https://www.gnu.org/licenses/gpl.txt))
## Copyright
2023-01-01 20:08:09 +03:00
Copyright © 2021-2023, [git-cliff contributors ](mailto:git-cliff@protonmail.com )