用途
changelog-generation 是一个用于生成人类可读更新日志(changelog)的技能。它适用于两种场景:为 Chromium 项目(按里程碑和子项目)生成变更摘要,以及为 GitHub 仓库(按两个标签之间的提交范围)生成变更摘要。用户提出“总结变更”“缺陷修复”“更新日志”等需求时,可调用此技能。
主要能力
- 抓取原始提交数据,并以 JSON 数组形式返回提交列表。
- 对 Chromium 提交:识别里程碑与子项目(支持 chromedriver、chrome-headless-shell、chrome-headless,也可传入原始 Chromium 路径),从提交信息中识别 Bug: <id> 或 Fixed: <id>,忽略 reland、revert、cleanup 等提交(除非包含重要信息)。
- 对 GitHub 提交:使用常规提交模式(如存在)进行分类,并查找 PR 编号或短哈希用于链接。
- 对提交进行相关性分类:区分对目标子项目真正相关的变更与内部/重构变更(如 IWYU 修复、变量重命名、C++ 特性更新、spanification、constexpr 更新、命名空间机械性变更、OWNER 调整等)。
- 将相关变更分组为“New features”“Bug fixes”“Other changes”,内部/重构变更归入“Internal changes and refactors”。按复杂度、代码行数或功能/修复大小排序。
- 合并属于同一逻辑变更的多个提交,重写为面向最终用户影响的一句项目符号描述。
- 为 Chromium 变更添加 Gerrit CL 链接(优先使用 review_number,缺失时回退到短哈希);为 GitHub 变更添加 PR 链接(优先)或短哈希链接;如提交信息包含缺陷跟踪链接也一并保留。
- 在变更落地版本与主发布版本不同时,以 HTML 上标形式标注首个版本/里程碑。
- 最终输出必须包裹在 ```markdown 代码块中,防止终端展开 Markdown 链接,方便用户复制原始 Markdown。
使用方式
- 确定需求:Chromium 项目需明确里程碑(如 149)和子项目(如 chromedriver);GitHub 仓库需明确 owner/repo、base tag 和 head tag。
- 运行生成脚本:
- Chromium:
node scripts/changelog-gen.js chromium <milestone> <subproject> - GitHub:
node scripts/changelog-gen.js github <owner/repo> <base_tag> <head_tag>
- Chromium:
- 处理脚本输出:读取 JSON 中的完整提交信息(含正文),深入理解变更内容与影响,不只看标题行。
- 按相关性分类并分组,合并同一逻辑变更,重写为简洁的项目符号描述。
- 添加相应链接(Chromium 用
[crrev.com/c/<review_number>](https://crrev.com/c/<review_number>),GitHub 用([#<pr_number>](https://github.com/<owner>/<repo>/pull/<pr_number>)),无 PR 时回退到短哈希链接)。 - 将最终更新日志包裹在 Markdown 代码块中输出。
适用场景
- 需要为 Chromium 特定里程碑的某个子项目生成变更摘要。
- 需要为 GitHub 仓库两个版本标签之间的提交生成更新日志。
- 需要将技术性提交信息改写成面向用户、易于理解的变更说明,并附带可追溯的链接。
限制
- 依赖脚本
scripts/changelog-gen.js抓取数据。 - 支持的 Chromium 子项目限于 chromedriver、chrome-headless-shell、chrome-headless,或已知的原始 Chromium 路径。
- 输出质量依赖模型对完整提交信息的阅读与判断,需避免仅凭标题行分类。
- 未提供安装方式、收费模式、平台兼容性等具体信息,暂未提供。