git-cliff/README.md

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.

Documentation

Learn how to use git-cliff from the documentation.

• Installation
• Usage
• Configuration
• Templating

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 ✨

Made with contrib.rocks.

Socials

License

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

Copyright

Copyright © 2021-2024, git-cliff contributors