Universal changelog generator using conventional commit+ with monorepo support. Written in Rust.

Jeff Yang

Last update: Nov 27, 2022

Related tags

Utilities rust changelog conventional-changelog changelog-generator conventional-commits

Overview

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 as putting under refactor is hard to find)
dx -> Developer Experience
docs -> Documentation
feat -> Features
perf -> Performance Improvements
refactor -> Refactoring

If there is ! after the commit types or commit scope, those commits will be under BREAKING CHANGES section.

Installation

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

cargo install chlog

Usage

chlog has command line options for generating and prepending changelogs.

For the first release, you can run with:

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

For the subsequent release,

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.

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

CLI:

  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  <string>          Tag name for the next release
    -r  <number>          Number of releases to generate the changelog
                          If 0, the whole changelog will be generated
                          (i.e. first release)
    -o  <file>            File to write the generated changelog
    -p  <file>            File to prepend the generated changelog
    --commit-path <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
```
git config core.hookspath .githooks
```

LICENSE

MIT

You might also like...

A CLI tool that automatically writes commit messages for you.

Automagically-generated commit messages A CLI tool that generates commit messages from your staged changes, built in Rust and using OpenAI's Codex. In

839 Jan 6, 2023

Easily add emojis to your git commit messages 😎

gimoji A CLI tool that makes it easy to add emojis to your git commit messages. It's very similar to (and is based on) gitmoji-cli but written in Rust

12 May 29, 2023

A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages

AI Commit Message acm A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages. Features Effortlessly create meaning

3 Nov 5, 2024

Error context library with support for type-erased sources and backtraces, targeting full support of all features on stable Rust

Error context library with support for type-erased sources and backtraces, targeting full support of all features on stable Rust, and with an eye towards serializing runtime errors using serde.

1 Feb 12, 2022

🦀 Rust-based implementation of a Snowflake Generator which communicates using gRPC

Clawflake Clawflake is a Rust application which implements Twitter Snowflakes and communicates using gRPC. Snowflake ID numbers are 63 bits integers s

5 Oct 31, 2022

A simple code boilerplate generator written in Rust.

💻 Cgen What is Cgen? A modern, cross-platform, multi-language boilerplate generator aimed to make your code generation less hectic! If you wish to su

1 Dec 25, 2021

Dead simple, minimal SPDX License generator library written in Rust.

lice Dead simple, minimal SPDX License generator library written in Rust. Lice is in beta Install | User Docs | Crate Docs | Reference | Contributing

9 Oct 22, 2023

Utilities to gather data out of roms. Written in Rust. It (should) support all types.

snesutilities Utilities to gather data out of roms. Written in Rust. It (should) support all types. How Have a look at main.rs: use snesutilities::Sne

5 Oct 12, 2022

A rewrite of Phonelink for Windows Forms written in Rust, with cross-platform support.

phonelink-rs A rewrite of Phonelink for Windows Forms written in Rust, with cross-platform support. Usage Clone the repository and build, or download

4 Aug 6, 2022

Comments

Configure Renovate
Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

.github/workflows/ci.yml (github-actions)

.github/workflows/release.yml (github-actions)

Configuration Summary

Based on the default config's presets, Renovate will:

Start dependency updates only once this onboarding PR is merged

Enable Renovate Dependency Dashboard creation

If semantic commits detected, use semantic commit type fix for dependencies and chore for all others

Ignore node_modules, bower_components, vendor and various test/tests directories

Autodetect whether to pin dependencies or maintain ranges

Rate limit PR creation to a maximum of two per hour

Limit to maximum 10 open PRs at any time

Group known monorepo packages together

Use curated list of recommended non-monorepo package groupings

Fix some problems with very old Maven commons versions

Ignore spring cloud 1.x releases

Ignore web3j 5.0.0 release

Ignore http4s digest-based 1.x milestones

Use node versioning for @types/node

Limit concurrent requests to reduce load on Repology servers until we can fix this properly, see issue 10133

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

It looks like your repository dependencies are already up-to-date and no Pull Requests will be necessary right away.

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 1
feat!: changelog writing is now unified under single -o option
Description

-p is now removed. Instead use -o as usual. It will create the output file if the file does not exist and write the changelog to it. If the file exists, the generated changelog will be prepended to the file.

Additional context

What is the purpose of this pull request?

[ ] Bug fix

[x] New Feature

[ ] Documentation update

[ ] Other
opened by ydcjeff 0