About git-cliff
git-cliff generates changelogs from your Git history. You control the output format with a configuration file, and it works best with the conventional commits style.
What it does
git-cliff reads the commits in a repository and groups them by type into sections, such as features and fixes. Parsers use regular expressions, so you can match your own commit style. The output template is set in a config file. It runs as a command line tool, and Rust projects can also use it as a library.
Key features
- Regex based commit parsers
- Output format set in a config file
- Groups commits into changelog sections
- Works with conventional commits
- Command line tool and Rust library
Who it's for
git-cliff suits developers who publish releases and want a changelog written from commit messages. The project site says it fits Rust, Python and Node.js projects.
Pricing and good to know
git-cliff is licensed under Apache-2.0 and free to use. Changelogs are only as good as the commit messages behind them, so teams that write vague commits will get vague release notes. The project publishes its documentation and a getting started guide.
Highlights
- Builds a changelog from commit history
- Groups commits into sections by type
- Uses regex parsers for custom commit styles
- Output format set in a config file
