/git-cliff

A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️

Primary LanguageRustApache License 2.0Apache-2.0




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.

preview

Documentation

Learn how to use git-cliff from the documentation.

In The Media

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.

Contributors

Thanks goes to these wonderful people ✨

Made with contrib.rocks.

License

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

Copyright

Copyright © 2021-2023, git-cliff contributors