VibeHunt
Back to browse

clog

A conventional changelog for the rest of us.

Source

clog generates a changelog automatically from a repository’s git history, relying on commit messages that follow the conventional format. When a developer writes commits with subjects like “type: description” or “type(scope): description”, clog parses the metadata and assembles a markdown changelog that groups changes by type and component. It also accepts empty components, allowing messages such as “alias: message” without a specified component.

The tool can be used as a command‑line binary or as a library through clog‑lib, giving flexibility for both manual updates and integration into build scripts. Installation options include compiling from source with Cargo, copying a precompiled binary into a directory on the system PATH, or using the AUR package on Arch Linux. Linux and macOS users can place the binary in any PATH‑listed folder, while Windows users can add its location to the PATH environment variable.

Typical usage involves running the `clog` command inside a git repository, optionally providing flags to customize output. The resulting changelog follows the Angular‑style conventional changelog specification, making it suitable for projects that adopt that standard.

Reviews

Sign in to leave a review.

Loading reviews…

Similar apps