git-cliff

OfficialAgent-ready

github.comDeveloper Tools12.3kgit-cliffUpdated 4d ago

About git-cliff

git-cliff parses Git commits and generates structured changelogs based on conventional commit patterns. It supports custom templates and filtering rules, allowing developers to automatically create release notes that match project conventions and documentation standards.

Key features

01Parse Conventional Commits and extract version-relevant information
02Customize changelog format using templates and configuration
03Filter and group commits by type, scope, or custom rules
04Initialize project configuration and export changelogs to Markdown

Use cases

01Automatically generate release notes in CI/CD pipelines
02Create project-specific changelog styles matching team conventions
03Maintain consistent, well-documented version history for open-source projects

Install

Pick your OS or package manager and run the command in a terminal.

brew install git-cliff

Once installed, rungit-cliff --versionto confirm it works.

Example commands

Common commands in the order you’d use them.

git cliff --init

git cliff -o CHANGELOG.md

Details

From the project README

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.

animation

Documentation

Learn how to use git-cliff from the official documentation.

You can also check out the blog posts written by the community:

An introduction to git-cliff for release management: Learn how to automate your software releases
Git-cliff and monorepos: An introduction to the monorepo capabilities of git-cliff
git-cliff: The Smart Way to Handle Changelogs

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

Comments

Markdown supported