Release Note Creator
流程
- 阅读
references/range-determination.md,了解如何确定变更范围 - 从远程获取 tag 列表
- 与上一步确定的前序 tag 进行比较,确定变更范围
- 阅读
references/release-note-guideline.md,了解如何撰写更新日志 - 如版本号、前序 tag 或更新日志范围存在歧义,再与用户确认
- 在无歧义时直接撰写更新日志
- 将更新日志写入
docs/release_notes/<version>.md
与 CD 工作流的关系
- CD 工作流(
.github/workflows/cd.yml)通过 workflow_dispatch 手动触发,create-draft-release.sh会在目标 commit 上检查docs/release_notes/<version>.md,文件缺失会导致发布失败 - 因此 release notes 必须在触发 CD 之前提交并推送到 main
- 版本号规则(由
prepare-release.sh校验):- 形如
0.1.0或0.1.0-rc.1,预发布标签仅允许alpha、beta、rc,分隔符为点(.) - 不使用
v前缀 - 预发布版本不能发布为 latest
- 形如
tips
- 使用 markdown 格式
- 不允许使用
gh命令,仅基于本地 git 信息工作 scripts/下的脚本都支持传递--help参数查看使用方法