chlog

Universal changelog generator using conventional commit+ with monorepo support.

chlog can generate the changelog from the conventional commits with a few extra commit types. The supported commit types are:

• fix -> Bug Fixes
• deps -> Dependency Updates
• deprecate -> Deprecations (Deprecations are important for users, putting under refactor is hard to find)
• dx -> Developer Experience
• docs -> Documentation
• feat -> Features
• perf -> Performance Improvements
• refactor -> Refactoring

Installation

Binary releases can be downloaded at GitHub release page or if you want to install with cargo:

sh cargo install chlog

Usage

chlog has command line options for generating and prepending changelogs.

For the first release, you can run with:

sh chlog -o CHANGELOG.md -r 0 -t v0.1.0

For the subsequent release,

sh chlog -p CHANGELOG.md -t v0.2.0

For the packages with monorepo, you can use commit-path option. It will generate the changelog scoped to that package.

sh chlog -p CHANGELOG.md -t v0.3.0 -r 2 --commit-path crates/scope-pkg

CLI:

```sh chlog

Description: Universal changelog generator using conventional commit+ with monorepo support

Usage: $ chlog [options]

Example: $ chlog -o CHANGELOG.md -t v1.0.0 $ chlog -p CHANGELOG.md -t v1.0.0 $ chlog -p CHANGELOG.md -t v1.0.0 -r 2 $ chlog -p CHANGELOG.md -t v1.0.0 -r 2 --commit-path crates/scope-pkg

Options: -t Tag name for the next release -r Number of releases to generate the changelog If 0, the whole changelog will be generated (i.e. first release) -o File to write the generated changelog -p File to prepend the generated changelog --commit-path Generate a changelog scoped to a specific directory

Flags: -h, --help Show this message -V, --version Show version number

Source: https://github.com/ydcjeff/chlog ```

Contribution

• Make sure you have installed Rust.

• Setup git hook

  sh git config core.hookspath .githooks

LICENSE

MIT