变更日志生成器

功能

• 丰富的变更日志格式
• 低配置的变更日志管理
• 可定制

查看效果

本项目使用 changen 来维护其变更日志，使用 github action。

• 变更日志文件 - 查看其语法提供的功能
• 其提交历史
• 发布 GitHub 工作流程 - 它将创建一个 PR

入门指南

1. 创建变更日志

   如果您还没有变更日志文件，可以使用 changen new。

2. 验证变更日志语法

   如果您已经有了变更日志文件，可以通过运行 changen validate 来查看其语法是否被接受。

3. 生成发布说明

   当您知道变更日志有效时，可以使用 changen generate 来生成关于最后一个提交的发布说明。

   它可以生成

   • 两个标签/提交之间的发布说明
   • 特定提交/标签的发布说明
   • 特定里程碑的发布说明

   默认情况下，它将从变更日志中的最后一个发布到最后一个提交生成发布说明。它将使用 git log 命令获取提交列表，并在必要时尝试与远程 PR 匹配。

4. 制作新版本

   要制作新版本，请使用 changen release --version 1.0.0。

[!WARNING]
所有 仓库的标签和变更日志中的版本 必须 符合 semver 格式，并且应相互匹配。

完整的 API 参考文档可以在 此处 找到（自动生成）。

提交语法

fix(project_a): Fix a nasty bug <=> commit-type(scope): commit-message

高级用法

忽略提交

目前，您可以在提交信息中的任何位置写入这些模式

• (跳过变更日志)
• (忽略变更日志)
• !变更日志
• !日志

将提交类型映射到章节（例如：### Fixed）在变更日志中

默认映射可在此处查看 这里。注意，顺序将定义章节在日志文件中的显示顺序。使用方法：changen generate --map path/to/map.json

变更日志自定义路径

changen generate --file path/to/CHANGELOG.md

致谢

• pom，因为它是一个出色的解析器。没有这个解析器，我可能已经放弃了这个项目！变更日志的解析器不到200行！

• Iced，因为它的变更日志维护得很好

• Gitoxide 变更日志，因为它使用了一个类似的工具（相当复杂且功能更强大）

• clap