SuperAPI AI 工具集

draft-release-notes

通用与其它

查看项目

更新于 10-16 08:09

技能介绍

用途:在稳定版发布(release cut)流程中,由发布智能体在 release/<version> 工作树中运行,生成作为 GitHub Release 正文的已提交发布说明文件(发布工作流通过 gh release create --notes-file docs/releases/v<version>.md 直接使用该文件,无 --generate-notes 兜底)。适用于目标稳定版本已知、docs/releases/v$NEXT.md 尚不存在时;不用于 -dev.N / -beta.N,也不用于回填已发布版本的说明。

主要能力与做法:以散文驱动,无脚本可跑,由智能体直接完成枚举、Linear 语境查询、筛选与撰写。先解析范围下界(最近稳定 v* 标签,排除 -dev.* / -beta.):PREV_TAG=$(git describe --abbrev=0 --tags --match 'v[0-9]' --exclude '-dev.' --exclude '-beta.');再用 git log --first-parent --oneline "$PREV_TAG"..HEAD 与 gh pr list / gh api 解析每个 PR 的编号、标题、作者、标签与是否首次贡献者。对形如 TML-NNNN 的内部标题,通过 Linear MCP 读取工单以理解面向用户的结果,但 Linear 仅作语境输入,绝不逐字复制客户名、内部理由、TML 编号或工单原句,行内引用 PR(#NNN)而非工单。

规则与筛选:每条内容必须可核验,均链接其 PR 供人工复核。必收录破坏性变更及触及公开表面的变更(@prisma-next/* 公共 API、CLI 命令/标志、prisma-next.config.ts 字段、contract 格式、磁盘迁移形态、错误码);默认排除纯内部重构、CI/工作流/工具、仅测试、chore/依赖升级、仅文档改动,且不设“内部变更”兜底段落。按固定小节顺序撰写:破坏性变更、功能、修复、新贡献者,无内容的小节省略;破坏性变更放在最前。

写法与链接:破坏性变更指向对应升级配方目录,使用 tag 固定的绝对 URL(如 https://github.com/prisma/prisma-next/blob/v$NEXT/skills/upgrade/prisma-next-upgrade/upgrades/<prev.minor>-to-<head.minor>/,扩展作者版为 skills/extension-author/prisma-next-extension-upgrade/...);配方缺失不阻断撰写,改为内联描述所需操作。代码可见的破坏性变更附简短 before/after 示例,示例取自配方而非自造;创作面示例用 PSL(```prisma)。完成后写入 docs/releases/v$NEXT.md,并在 CHANGELOG.md 顶部前置 ## v$NEXT 条目(最新在前,无第二套格式),以独立提交签名提交:git add docs/releases/v$NEXT.md CHANGELOG.md 与 git commit -s -m "docs(release): add release notes for v$NEXT"。

退降与限制:Linear 不可用或 PR 无工单时仅凭标题与 diff 概括,不阻塞;无先前稳定标签时从最早标签或仓库根起枚举并注明为首个整理版;跨多个 minor 的跳过发布按连续过渡目录链锚定。不在范围内:发布时存在性门禁与 --notes-file 接线、把该技能接入 publish-npm-version 及版本化文档更新、dev/beta 发布说明、已发布版本回填、.github/release.yml 标签配置或第三方发布说明工具。