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.
- Install git-cliff:
cargo install git-cliff
Also, see the other installation options.
- Initialize git-cliff:
git cliff --init
Edit the default configuration (
cliff.toml) as you like. Check out the examples for different templates.
- Generate a changelog:
git cliff -o CHANGELOG.md
See the command-line usage examples.
Contributions are highly appreciated! See the contribution guidelines for getting started.
Feel free to submit issues and toss ideas!