git-cliff

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)
• git-cliff: The Smart Way to Handle Changelogs (Blog post)

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

Changelog

2.7.0 - 2024-11-20

⛰️ Features

• (args) Add color to the help text (#897) - (f423484)
• (ci) Add Nix CI (#939) - (d0848ff)
• (config) Allow overriding the remote API URL via config (#896) - (6d86e2c)
• (docker) Build arm64 images again (#879) (#919) - (84771f6)
• (jujutsu) Add jujustu support (#930) - (ab95626)
• (nix) Add a basic Nix environment (#918) - (6b17736)
• (website) Add user testimonials (#895) - (ef2374c)

🐛 Bug Fixes

• (bitbucket) Match PR and release metadata correctly (#907) - (e936ed5)
• (changelog) Fix missing commit fields in context (#837) (#920) - (f8641ee)
• (changelog) Include the root commit when --latest is used with one tag (#901) - (508a97e)
• (remote) Preserve first time contributors (#925) - (99b78b5)

📚 Documentation

• (git) Improve docs for commit_preprocessors and commit_parsers (#928) - (c1f1215)
• (readme) Add blog post about git-cliff - (82b10ac)
• (website) Add highlights for 2.7.0 (#955) - (b6b5449)
• (website) Add more testimonials - (bfe9beb)
• (website) Update sourcehut (#894) - (bcc32ca)

⚡ Performance

• (test) Don't create regex inside a loop (#937) - (0fabf22)

🧪 Testing

• (git) Find upstream remote when using ssh (#926) - (2e65a72)
• (repo) Expand unit tests of the repo module (#909) - (da1cb61)

⚙️ Miscellaneous Tasks

• (config) Add the 'other' parser to the default config - (12cb1df)
• (docker) Upgrade Rust and libc version in Dockerfile - (8bd0607)
• (docker) Bump the Rust version in Docker image - (c28121c)
• (integration) Remove experimental feature disclaimer - (237c327)
• (log) Add trace log about which command is being run - (a9b2690)
• (nix) Update flakes - (7654e67)
• (website) Add new testimonials - (0c207d6)

◀️ Revert

• (docker) Bump the Rust version in Docker image - (fc142e4)

New Contributors ❤️

• @pauliyobo made their first contribution in #896
• @blackheaven made their first contribution in #939
• @Muhammad-Owais-Warsi made their first contribution in #928
• @kemitix made their first contribution in #930
• @mcwarman made their first contribution in #925
• @LtdSauce made their first contribution in #919
• @dqkqd made their first contribution in #920
• @gsquire made their first contribution in #909
• @rarescosma made their first contribution in #901
• @vsn4ik made their first contribution in #894