SuperAPI AI 工具集

github-release-best-practices

部署与运维

查看项目

更新于 10-15 20:30

技能介绍

用途:作为 GitHub 发布准备的背景参考资料,说明版本号与变更日志规范,本身不是可执行的发布流程。

主要能力:给出 0.x 阶段的 SemVer 建议(破坏性变更升 minor 或 major,由团队决定;新功能优先 minor;修复用 patch);列出 CHANGELOG 分类 Added、Changed、Deprecated、Removed、Fixed、Security;说明发布前准备步骤。

使用方式:发布前通过 PR 到 main 完成准备——在根 Cargo.toml 提升 workspace 版本(所有成员跟随 workspace);更新 CHANGELOG.md,确保只有一个 ## [X.Y.Z] - YYYY-MM-DD 版本标题(重复标题会导致 cargo-dist/parse-changelog 静默失败,生成空的 GitHub Release 正文);在 plans/ROADMAPS/ROADMAP_ACTIVE.md 和 plans/STATUS/CURRENT.md 中把 Released Version 设为 vX.Y.Z;合并 PR 并等待 main CI 通过;然后运行 ./scripts/release-manager.sh ship --execute;用 gh release view vX.Y.Z 确认 Release Notes 内容。

限制:规范流程为 release-guard,规范 CLI 为 ./scripts/release-manager.sh ship --execute,GitHub Release 由 .github/workflows/release.yml 在打 tag 时创建。禁止使用 gh release create vX.Y.Z ...,因为会绕过 cargo-dist 和 release.yml 预检。参考资料还包括 ADR-034 Release Engineering、.agents/skills/release-guard/SKILL.md 和 ./scripts/release-manager.sh。