关于 github-release-best-practices
github-release-best-practices 是一份 GitHub 发布流程参考文档，适合使用该仓库发布流程的维护者。它说明发布前的版本与变更日志准备、执行命令及核验方式，并要求遵循既定发布路径。
主要功能
- 01说明 Cargo.toml 版本更新
- 02规定变更日志版本标题格式
- 03列出发布前的路线图与状态更新
- 04提供发布命令及发布说明核验
- 05说明 Semver 与变更分类
适用场景
- 01准备合并前的发布变更
- 02按照既定脚本执行发布
- 03检查 GitHub Release 说明内容
- 04判断修复或功能的版本递增方式
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/github-release-best-practices确认已加载。
附带文件evals/evals.json
详细介绍
GitHub 发布最佳实践（仅供参考）
规范流程： release-guard
规范 CLI：./scripts/release-manager.sh ship --execute
GitHub Release 创建者：.github/workflows/release.yml（仅推送标签时）
不要另行创建发布流程。本文件仅作为辅助参考。
发布前准备（通过 PR 提交到 main）
- 在根目录
Cargo.toml中提升工作区version（所有成员都遵循工作区版本）。 - 更新
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内容（采用 v0.1.34/v0.1.35 格式）。
Semver（0.x）
| 变更 | 提升 |
|---|---|
| 破坏性变更 | 次版本或主版本（由团队决定） |
| 功能 | 优先提升次版本 |
| 修复 | 补丁版本 |
更新日志类别
新增 · 变更 · 弃用 · 移除 · 修复 · 安全
禁止事项
# DO NOT — bypasses cargo-dist and release.yml preflight
gh release create vX.Y.Z ...
参考资料
- ADR-034 发布工程
.agents/skills/release-guard/SKILL.md./scripts/release-manager.sh
评论
支持 Markdown