chlog

使用常规提交+支持多仓的通用变更日志生成器。

chlog 可以从具有一些额外提交类型的常规提交中生成变更日志。支持的提交类型包括

• fix -> 错误修复
• deps -> 依赖更新
• deprecate -> 弃用（弃用对用户很重要，因为将其放在重构下很难找到）
• dx -> 开发者体验
• docs -> 文档
• feat -> 功能
• perf -> 性能改进
• refactor -> 重构

如果提交类型或提交范围内有 !，则这些提交将位于“重大变更”部分。

安装

可以在 GitHub 发布页面 下载二进制发布版本，或者如果您想使用 cargo 安装

cargo install chlog

用法

chlog 为生成和添加变更日志提供了命令行选项。

对于第一个发布版本，您可以使用以下命令运行

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

对于后续发布版本，

chlog -o CHANGELOG.md -t v0.2.0

对于多仓（monorepo）的包，您可以使用 commit-path 选项。它将生成针对该包的变更日志。

chlog -o CHANGELOG.md -t v0.3.0 -r 2 --commit-path crates/scope-crate

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 -o CHANGELOG.md -t v1.0.0
    $ chlog -o CHANGELOG.md -t v1.0.0 -r 2
    $ chlog -o CHANGELOG.md -t v1.0.0 -r 2 --commit-path crates/scope-crate

  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) (default: 1)
    -o  <file>            File to write the generated changelog
                          It will prepend the changelogs if the file exists
                          otherwise, will create a new one
    --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

贡献

• 请确保您已安装 Rust。

• 设置 git 钩子

  git config core.hookspath .githooks
  

许可证

MIT