SuperAPI AI 工具集

sync-changelog

通用与其它

查看项目

更新于 10-16 01:19

技能介绍

用途:在 kimi-code 发版成功后,把 CLI 包 @moonshot-ai/kimi-code 的变更记录同步到文档站,并翻译为中文。gen-docs 流程不会自动执行,需维护者在 Release PR 合并、Version Packages 完成、npm publish 成功之后手动运行;Release PR 合并前不要运行。

来源与目标:唯一上游为 apps/kimi-code/CHANGELOG.md(由 changesets 生成,禁止手动编辑),需写入 docs/en/release-notes/changelog.md 与 docs/zh/release-notes/changelog.md。英文文档是事实来源,中文由英文翻译。packages/*/CHANGELOG.md 等内部包不进入文档站。

前置条件:确认版本已在 npm 发布(npm view @moonshot-ai/kimi-code versions --json)或有对应 GitHub Release tag,且上游文件顶部为该版本;否则停下来与用户确认。不得在 main 上编辑或直接提交。

流程:先从最新默认分支拉取并创建 docs/changelog-sync-<newest-version> 分支(分支已存在则停止确认);确定版本范围(首次同步全部,增量只同步英文页尚无的较新版本块,最新在前);剥离装饰,保留版本标题 ## x.y.z 与条目正文,移除上游 H1、### Patch/Minor/Major Changes 子标题、PR 链接、commit 哈希链接和 Thanks ...! 致谢;剔除仅 SDK 或 provider 内部细节,保留用户可感知的效果与必须遵守的限制;上游条目须为英文,发现非英文条目应停止并报告;不得把真实内部端点、密钥名、账号或服务名写入文档,用 example.com、YOUR_API_KEY 等占位。

整理与分类:统计版本范围内剥离后的条目数,10 条及以下全部列出交用户决定,仅给出建议性提示;超过 10 条先按规则合并与归并再送审。用读者行动测试与渠道测试判断是否保留:功能项用户会尝试或必须反应则保留;优化只保留必须反应项;修复只保留改变了行为的修复;其余低信号条目折叠为兜底条目,末尾附上游文件链接。同一界面或同类修复达到三条以上可合并,宽泛、高价值或明显独立的修复保持单条。文档 changelog 使用五类分节:Features/新功能、Polish/优化、Bug Fixes/修复、Refactors/重构、Other/其他。完成英文页后进行中文翻译,可选人工审核,然后在专用分支提交并开 PR。

限制:资料未提供自动化触发方式、具体耗时或收费信息。