变更日志生成器

功能

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

查看实际效果

此项目使用 changelog-gen 维护其变更日志，使用 GitHub 动作

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

入门

1. 创建变更日志

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

2. 验证您的变更日志语法

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

3. 生成发布说明

   当您知道您的变更日志有效时，可以使用 changelog-gen generate 来生成关于最新提交的发布说明。

   它可以生成发布说明

   • 在两个标签/提交之间
   • 对于特定的提交/标签
   • 对于特定的里程碑

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

4. 创建新版本

   要创建新版本，请使用 changelog-gen release --version 1.0.0。

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

完整的API参考可以在这里找到（自动生成）。

提交语法

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

高级用法

忽略提交

目前，您可以在提交信息或描述的任何地方写入这些模式

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

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

默认映射可以在这里查看。注意，顺序将定义章节在日志文件中出现的顺序。使用时，请使用changelog-gen generate --map path/to/map.json

变更日志自定义路径

changelog-gen generate --file path/to/CHANGELOG.md

致谢

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

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

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

• clap