SuperAPI AI 工具集

breaking-change-doc

写作与研究

查看项目

更新于 10-15 21:12

技能介绍

用途:为 dotnet/runtime 中引入破坏性变更的已合并 PR,在 dotnet/docs 生成结构化的破坏性变更说明 issue,内容包括变更、影响和迁移指引。

触发方式:交互式可让 Copilot 处理指定 PR(如“Document the breaking change in PR #114929”);自动化方式由 .github/workflows/breaking-change-doc.md 工作流在带 needs-breaking-change-doc-created 标签的 PR 合并时触发,也支持 workflow_dispatch 手动运行,并可用 suppress_output 做干跑检查。

主要流程:读取 PR 元数据、正文、改动文件、评论与评审、关联 issue,并从 area-* 标签映射到文档特性区域;运行 Get-VersionInfo.ps1 检测 .NET 版本;在 dotnet/docs 中以 breaking-change 标签搜索“Breaking change <PR_NUMBER>”查重;读取官方 issue 模板与近期示例;按模板撰写标题、描述、版本、旧/新行为、变更类型、原因、推荐操作、特性区域与受影响 API;最后写出 artifacts/docs/breakingChanges/issue-draft.md,并用 Build-IssueComment.ps1 生成含预填新建 issue 链接的 PR 评论。必要命令示例:pwsh .github/skills/breaking-change-doc/Get-VersionInfo.ps1 -PrNumber <number>;pwsh .github/skills/breaking-change-doc/Build-IssueComment.ps1 -IssueDraftPath artifacts/docs/breakingChanges/issue-draft.md -Title "<标题>" -Labels "<标签>" -IssueAssignees "<用户名>" -CcMentions "@user1 @user2" -OutputPath artifacts/docs/breakingChanges/pr-comment.md。

限制与注意:仅处理已合并 PR;无 area-* 标签时会报错并要求补充;版本脚本输出中 Tentative 为真时需确认关联 PR 是否为真实 backport,否则改用 FallbackVersion;查重命中已有 issue 时停止;未明确要求创建时默认仅出草稿;自动评论需在非干跑且用户明确要求时发布。价格与其它平台支持暂未提供。