README

<p align="center"> <a href="https://git-cliff.org"> </a>

<a href="https://github.com/orhun/git-cliff/releases">
    </a>
<a href="https://crates.io/crates/git-cliff/">
    </a>
<a href="https://codecov.io/gh/orhun/git-cliff">
    </a>


<a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Integration%22">
    </a>
<a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Deployment%22">
    </a>
<a href="https://hub.docker.com/r/orhunp/git-cliff">
    </a>
<a href="https://docs.rs/git-cliff-core/">
    </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 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.

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

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 ✨

Made with contrib.rocks.

Socials

<a href="https://discord.gg/W3mAwMDWH4"> </a>  <a href="https://matrix.to/#/#git-cliff:matrix.org"> </a> <a href="https://discord.gg/W3mAwMDWH4"> </a> <a href="https://twitter.com/git_cliff"> </a> <a href="https://fosstodon.org/@git_cliff"> </a>

License

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