Copilot 结构化发布说明
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/generate-structured-release-notes-from-merged-pull-requests-between-two-refs-with-copilot-release-notes。
技能介绍
它解决什么问题
发版前手写 release notes 是一件容易出错的琐事:要么靠人肉翻 commit log 和 PR 列表,要么漏掉跨分支合入的改动,格式也难以统一。这个技能面向发布流程中的变更汇总环节,把两个引用之间的合并 PR 自动转成结构化的 Markdown 与 JSON 发布说明,供人工 review 后直接进入 release。
它如何工作
- 输入是两个引用(tag、分支或 SHA)作为比较范围,圈定本次发布包含的改动区间
- 借助 GitHub API 把区间内的 commit 关联到对应的 PR,因此能覆盖多种 PR 类型
- 由 Copilot Release Notes 对合并 PR 做总结,产出结构化结果:
Markdown供直接阅读,JSON便于下游流水线消费 - 输出作为 release workflow 的一环,供 review、归档或发布使用
适用边界与注意点
- 需要 GitHub Actions runner(Ubuntu、macOS 或 Windows),且被比较引用的 git 历史已完成 checkout
- 需要有效的 GitHub Copilot license,且 token 所有者必须持有 active 订阅
- 认证使用
COPILOT_GITHUB_TOKEN,即带 Copilot Requests: Read 权限的 fine-grained PAT - 因为走 GitHub API 查询 commit 与 PR 的关联,覆盖面更广,但在大区间下速度较慢,且必须具备 API 访问权限
- 上游来源:github.com/1991513ccie-png/skills,提炼自 copilot-release-notes 上游文档
使用场景
- 版本发布前,需要把当前 tag 与上一个 tag 之间所有已合并的 PR 汇总成结构化发布说明,供团队 review
- 分支合并完成后,需要把 develop 相对 main 的改动整理成可直接发布的 release notes,用于版本存档
- 需要提取两个 SHA 之间的变更生成 Markdown 格式发布说明,同时输出 JSON 供下游 CI 流水线消费
- 发版范围跨多个 PR 类型时,需要覆盖 squash merge 之外的其他 PR 合并方式,确保发布说明完整
适合人员
- 负责版本发布的 DevOps 工程师,需要在每次 release 前自动汇总区间内所有合并 PR 的变更并生成可 review 的发布说明
- 维护开源仓库的开发者,希望 tag 之间的改动能自动整理成结构化的 release notes 提交到仓库存档
- CI 流水线负责人,需要在发版步骤中生成 JSON 格式的发布说明供下游工具解析和归档
- 发布经理,需要在大版本发布前快速拿到两个引用之间所有合并 PR 的摘要,核对改动覆盖范围