What is this?
git-cliff is a highly customizable changelog generator that builds changelog files from your Git commit history, following the Conventional Commits specification and the Keep a Changelog format.
git-cliff is a highly customizable changelog generator that builds changelog files from your Git commit history, following the Conventional Commits specification and the Keep a Changelog format.Is this a CLI tool or a library?It is a command-line tool written in Rust that you run inside a Git repository; it is not a library you import into code.
It is a command-line tool written in Rust that you run inside a Git repository; it is not a library you import into code.How do I get it running?Install git-cliff following the official documentation's Installation guide, then run it in a Git repository so it reads the commit history and produces a changelog file.
Install git-cliff following the official documentation's Installation guide, then run it in a Git repository so it reads the commit history and produces a changelog file.Do my commits need to follow Conventional Commits for this to work?It works best with Conventional Commits, but it also supports regex-powered custom parsers so you can handle commits that don't follow that convention.
It works best with Conventional Commits, but it also supports regex-powered custom parsers so you can handle commits that don't follow that convention.How do I customize the changelog's look and content?The changelog template can be customized through a configuration file, letting you match whatever format you want instead of a fixed layout.
The changelog template can be customized through a configuration file, letting you match whatever format you want instead of a fixed layout.Does it work with monorepos?Yes, there is community documentation specifically covering git-cliff's monorepo capabilities for generating per-package or combined changelogs.
Yes, there is community documentation specifically covering git-cliff's monorepo capabilities for generating per-package or combined changelogs.How is it different from tools like clog-cli or cocogitto?It's one of several Conventional Commits based changelog tools (alongside clog-cli, cocogitto, release-plz, etc.), but git-cliff emphasizes heavy template customization and regex-based parsing beyond the strict Conventional Commits spec.
It's one of several Conventional Commits based changelog tools (alongside clog-cli, cocogitto, release-plz, etc.), but git-cliff emphasizes heavy template customization and regex-based parsing beyond the strict Conventional Commits spec.Can I run it in CI to automate releases?Yes, the project is commonly used in release pipelines; its own repo includes CI workflows (e.g. cd.yml) for automated changelog generation and release checks.
Yes, the project is commonly used in release pipelines; its own repo includes CI workflows (e.g. cd.yml) for automated changelog generation and release checks.What are similar projects?semantic-release, git-history, git, eza, gitui, husky, jev-code-reviewer, issue-graph
semantic-release, git-history, git, eza, gitui, husky, jev-code-reviewer, issue-graphWhich topics is it in?commit, semver, changelog, generator, github, ci, cli-tool, git, customization, hacktoberfest, rust, command-line-tool
commit, semver, changelog, generator, github, ci, cli-tool, git, customization, hacktoberfest, rust, command-line-tool