git-cliff – orhun

<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><!-- </a> being on the same line as the <img> tag is intentional! -->
<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>
</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 files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. The changelog template can be customized with a configuration file to match the desired format.

Documentation

Learn how to use git-cliff* from the official documentation.

• Installation
• Usage
• Configuration
• Templating

You can also check out the blog posts written by the community:

• An introduction to git-cliff for release management: Learn how to automate your software releases
• Git-cliff and monorepos: An introduction to the monorepo capabilities of git-cliff
• git-cliff: The Smart Way to Handle Changelogs

In The Media

• Turning Git commits into changelog with git-cliff - RustLab 2023 (Talk)
• An Interview with Orhun of git-cliff - Console #141 (Newsletter)
• KaiCode Open Source Festival 2024 (Second place winner)

Editor Support

• git-cliff.el - Generate, update and release changelog in Emacs

Similar/Related Projects

• git-journal - The Git Commit Message and Changelog Generation Framework
• clog-cli - Generate beautiful changelogs from your Git commit history
• relnotes - A tool to automatically generate release notes for your project.
• cocogitto - A set of CLI tools for the conventional commit and semver specifications.
• cliff-jumper - A NodeJS CLI tool that combines git-cliff and

conventional-recommended-bump
to semantically bump a NodeJS package and generate a git-cliff powered changelog.

• release-plz - Release Rust packages from CI.
• git-changelog-command-line - Generate changelog and determine next version with conventional commits.
• git-changelog: Automatic Changelog generator using Jinja2 templates.

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.

Socials

<a href="https://discord.gg/W3mAwMDWH4">
<img src="https://discord.com/api/guilds/1093977388892819553/embed.png?style=banner2"></a> <!-- </a> being on the same line as the <img> tag is intentional! -->
<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>
<a href="https://twitter.com/git_cliff">
<img src="https://img.shields.io/badge/follow-@git__cliff-BEC5C9?style=flat&logo=x&logoColor=BEC5C9&labelColor=1C2C2E"></a>
<a href="https://fosstodon.org/@git_cliff">
<img src="https://img.shields.io/mastodon/follow/111545487385097711?domain=https%3A%2F%2Ffosstodon.org&style=flat&labelColor=1C2C2E&color=BEC5C9&logo=mastodon&logoColor=BEC5C9"></a>

License

Licensed under either of Apache License Version 2.0 or The MIT License at your option.

Copyright

Copyright © 2021-2025, git-cliff contributors