SuperAPI AI 工具集

changelog-release-notes

写作与研究

查看项目

更新于 10-16 09:30

技能介绍

用途:BK-CI 发版 Changelog 的增量处理工作流。适用于用户已写好中文 Changelog 某一版本明细(如 # v4.2.0-rc.4),需要生成「变更概述」写回中文文件,并把该增量版本整段翻译到英文 Changelog 的场景。默认假设中文明细已存在,不替用户从零生成完整 issue 明细。

主要能力:一是基于目标版本块生成中文「变更概述」,只处理当前新增的那一个版本块,不遍历整个文件;二是将该版本块全文(含概述与原有明细)翻译为英文并插入英文文件顶部。支持按需裁剪:只生成概述(步骤 1~3),或概述已有、只翻译英文(步骤 1、4、5)。

文件约定:中文 CHANGELOG/zh_CN/CHANGELOG-<major.minor>.md,英文 CHANGELOG/en/CHANGELOG-<major.minor>.md;新版本块通常位于顶部 <!-- NEW RELEASE NOTES ENTRY --> 之后、旧版本之前。增量范围为目标版本标题到下一版本标题之间的内容。

输入确认:目标版本必填;基线版本可选,默认从该块 Changelog since 读取;文件路径可按 major.minor 推断。标准流程:定位并只读该增量块→生成变更概述→写回中文该版本块→仅翻译该增量块→插入英文文件顶部,完成后汇报概述条数与写入位置。

概述体量约特性 5~8 条、Bug 2~4 条,短句、以支持/增加/修复开头,不写 issue 链接与 feat/bug 前缀;同一主题多条合并。筛选优先级:提交集中主题合并主推,用户可感知新能力单独成条,API/性能/依赖升级等默认不进概述。可选只读命令:git log --oneline <基线tag>..<目标tag>。

翻译侧提供章节标题与条目标签的中英映射(如新增→New Features、优化→Improvements、修复→Bug Fixes),保留 issue 链接、版本号、日期,产品专有名词可保留,英文概述与中文概述条数一致。写入时若英文文件已存在该版本,先询问用户,默认不覆盖,且不改写历史版本。

限制:默认不创建 git commit,除非用户明确要求;不主动修改历史版本概述或翻译;拿不准的条目默认不进概述,可在回复末尾列「可选补充项」供用户决定。触发示例:「按 changelog-release-notes,处理 v4.2.0-rc.4 增量」「中文 rc.4 已写好,补概述并同步英文」「只生成概述,先别写英文」「概述已有,只翻译英文」。其余未在资料中说明的能力暂未提供。