Skip to content
text
# Related Code
- `tools/gen-release-notes/main.go`
- `tools/gen-release-notes/templates/`
- `release-notes/notes/`
- `release-notes/template.yaml`
- `versions.json`

发布流程

概览

发布流程以 release-notes/notes 为输入,生成 Markdown/HTML release notes,再配合 CI 完成版本发布。

典型步骤

  1. release-notes/notes/<version>/ 中新增或更新 YAML 变更条目
  2. 生成 release notes
bash
go run ./tools/gen-release-notes \
  --oldRelease v0.x.y \
  --newRelease v0.x.z \
  --notes ../../ \
  --outDir ../../changes
  1. 审核 changes/ 中生成的文档
  2. 配合 CI/Tag 流程完成发布

版本约束

  • versions.json 记录当前版本号
  • Git tag 决定 release 范围与最终版本号

常见问题

  • 没有找到 release-notes/notes:检查路径与 --notes 参数
  • 生成结果为空:确认 newRelease 与目录存在对应变更条目