A highly customizable Changelog Generator that follows Conventional Commit specifications.

<a href="https://github.com/orhun/git-cliff/releases">
    <img src="https://img.shields.io/github/v/release/orhun/git-cliff?style=flat&amp;labelColor=1C2C2E&amp;color=C96329&amp;logo=GitHub&amp;logoColor=white" /></a>
<a href="https://crates.io/crates/git-cliff/">
    <img src="https://img.shields.io/crates/v/git-cliff?style=flat&amp;labelColor=1C2C2E&amp;color=C96329&amp;logo=Rust&amp;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&amp;labelColor=1C2C2E&amp;color=C96329&amp;logo=Codecov&amp;logoColor=white" /></a>

<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&amp;labelColor=1C2C2E&amp;color=BEC5C9&amp;logo=GitHub%20Actions&amp;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&amp;labelColor=1C2C2E&amp;color=BEC5C9&amp;logo=GitHub%20Actions&amp;logoColor=BEC5C9&amp;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&amp;labelColor=1C2C2E&amp;color=BEC5C9&amp;label=docker&amp;logo=Docker&amp;logoColor=BEC5C9" /></a>
<a href="https://docs.rs/git-cliff-core/">
    <img src="https://img.shields.io/docsrs/git-cliff-core?style=flat&amp;labelColor=1C2C2E&amp;color=BEC5C9&amp;logo=Rust&amp;logoColor=BEC5C9" /></a>

Documentation | Website

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.

animation

Documentation

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

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.