git-cliff-darwin-x64

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

Changelog

2.6.0 - 2024-09-22

⛰️ Features

• (changelog) Support generating changelog for different branches (#808) - (2a581a8)
• (config) Add changelog.render_always option (#859) - (ad039d5)
• (config) Allow configuring output file from config (#829) - (c2db791)
• (core) Add remote to commit and deprecate fields (#822) - (87e2c1d)
• (npm) Add missing options and document all options with tsdoc comments - (2eae2f1)
• (npm) Add possibility for skipCommit to take an array of values - (a6e3b78)

🐛 Bug Fixes

• (args) Support using use_branch_tags from both config and args (#848) - (35b7fd8)
• (bump) Suppress template warning when --bumped-version is used (#855) - (8bebbf9)
• (changelog) Do not change the tag date if tag already exists (#861) - (fbb643b)
• (changelog) Correctly set the tag message for the latest release (#854) - (e41e8dd)
• (changelog) Don't change the context when provided via --from-context (#820) - (ff72406)
• (commit) Trim the trailing newline for git2 commits (#872) - (1cdbbf6)
• (core) Avoid the unnecessary loop when no remote feature is activated - (1d8a2fe)
• (template) Resolve parsing issues with raw/endraw in Jinja (#824) - (63bf5b7)

🚜 Refactor

• (template) [breaking] Add name parameter to the constructor - (e577113)

📚 Documentation

• (args) Fix copy-paste mistake where gitea mentioned gitlab - (c41eacb)
• (contributing) Mention fetching the tags for running tests successfully (#850) - (a82dac3)
• (website) Add highlights for 2.6.0 (#873) - (050fb55)
• (website) Clarify comment about tag argument - (e56cd8d)

⚙️ Miscellaneous Tasks

• (ci) Check pedantic lints (#853) - (c77420c)
• (examples) Improve example templates (#835) - (08e761c)
• (lib) Fix typos in code comments - (81854d2)
• (npm) Bump dev dependencies - (61b86f1)

New Contributors ❤️

• @nejcgalof made their first contribution in #853
• @pplmx made their first contribution in #824