用途
API Review 用于在 Playwright 发布前,从一段提交范围内筛选出需要写入发布说明的 API 变更。它不是变更日志(changelog):只有用户需要学习新 API,或现有测试套件可能因行为变化而得到不同结果时,变更才会被收录。
主要能力
- 自动选择审查范围:支持显式指定
v1.64.0..main或abc1234..main,也支持根据「上一次审查」或「上一次发布」自动推导范围。 - 收集候选提交:通过 git log、grep 文档中的
since: v1.xx标记、对比公共类型定义、CLI/MCP 选项、环境变量等,列出所有可能影响公共 API 或用户行为的提交。 - 判定收录标准:明确区分「新增公共 API」「破坏性变更」「非缺陷修复的行为变更」以及「达到影响门槛的缺陷修复」,并给出排除理由。
- 按影响排序:将收录项分为多个影响层级,优先展示运行时无编译提示的破坏性变更,其次是上一版本已发布行为被回退或再次改变,再次是可能翻转测试结果的行为变更,然后是多数用户会采用的新 API,最后是受众较窄的新选项和标志。
- 文档检查:对每个收录项,在 playwright.dev 文档中查找对应页面,并给出文档状态徽章(OK、Partial、Needs notes、README stale、None、Internal、Missing),同时生成 issue 草稿中的文档任务。
- 生成 HTML 审阅页面:复制模板文件并填充占位符,保持 CSS、类名和脚本不变,使页面支持反馈填写和 issue 草稿生成。
- 支持语言移植版本:对 Python、Java、.NET 移植版本,同时审查移植仓库本身的 PR 和从核心仓库通过 driver 传入的变更,并用对应语言编写代码片段。
使用方式
命令格式为 /api-review [python|java|dotnet] [range]。不带语言参数时,审查 microsoft/playwright 主仓库(Node.js 包、测试运行器、MCP 和 CLI)。带语言参数时,审查对应移植版本。整个过程中只操作当前检出目录,不提交任何内容。
适用场景
- Playwright 维护者在发布前需要一份按影响排序、每项附带文档状态的 API 审阅清单。
- 需要明确哪些变更是破坏性变更、哪些行为变更可能影响现有测试套件、哪些需要写入发布说明。
- 需要为 Python、Java、.NET 移植版本生成包含客户端、打包、库和文档变更的审阅页面。
限制
- 依赖当前 git 检出和 gh CLI 访问 GitHub 仓库,不适用于没有仓库访问权限的环境。
- 不生成变更日志,只收录需要用户采取行动或可能影响测试结果的变更。
- 对语言移植版本的审查需要先存在同一版本的核心审查,否则需先对核心范围执行候选收集和判定步骤。
- 不覆盖安全加固且无 API 表面的变更。
- 关于收费、价格、平台限制等具体信息,资料未提供。