GitHub Release 发布说明

为刚打 tag 的版本写一份分类整理过的 GitHub Release 发布说明并写回 Release:素材 → 分类 → 落盘 → gh release create/edit → 验证。适用于任何 tag-push → GitHub Release 的项目——npm 包或非 npm 项目(桌面软件)。模板与反模式在 references/release-notes-guide.md,本文件只定流程。

执行须知

发布说明直接公开发布,读者是最终用户(npm 场景是调用方开发者)。质量红线:每条都写"对读者来说变了什么",不堆 commit 标题;没有的分类整节删掉,不空占位。gh release create/edit 前先 --help 核实旗标,不凭记忆拼。

发布说明正文一律用英文——参考的模板骨架已是英文,正文(亮点段、bug 条目、Breaking Changes 迁移说明)同样不写成中文。

步骤

1. 摸底与素材

完成判据:素材齐备——完整提交列表、PR 上下文(若走 PR 合并)、仓库的 Release 约定已确认,且 tag 名与要发布的版本一致(桌面项目若在 manifest 里维护版本,一并核对)。

• 先确认仓库约定:这个仓库建 GitHub Release 吗?gh release list 为空或历史版本从无 release → 按仓库约定跳过本 skill,不要自作主张建 release。
• git log <上一个 tag>..HEAD --oneline 拿完整提交列表,先拿全再动笔,不要边读边写。
• 仓库走 PR 合并 → gh pr list --state merged --search "merged:>=<上次发布日期>" 补 PR 描述作为素材。
• 素材来源的细节按 guide 的"素材来源"节。