Documentation | Website

**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. ![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif) ## 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) - [KaiCode Open Source Festival 2024](https://www.kaicode.org/2024.html) (Second place winner) ## 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. - [git-changelog](https://github.com/pawamoy/git-changelog): Automatic Changelog generator using Jinja2 templates. ## Contributors Thanks goes to these wonderful people ✨ Made with [contrib.rocks](https://contrib.rocks). ## Socials
## 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)