用途
dependabot-review 用于审查 Dependabot 提交的 gem 升级拉取请求(PR),为开发者提供简洁、可快速浏览的结论:上游发生了什么变化、可能破坏什么(以及如何修复)、每个 gem 在代码库中涉及哪些部分,以及是否应该合并。
主要能力
该技能支持两种工作模式:
- 单 PR 模式:当用户粘贴某个具体的 Dependabot PR URL 或明确指向一个 PR 时,执行单 PR 审查流程。
- 审计模式:当用户询问所有开放的 Dependabot PR 时(例如“audit our deps”“review open dependabot PRs”“which dep upgrades are safe to merge”),执行审计流程。此模式不需要用户粘贴 URL,而是通过 gh 命令自动发现 PR。如果意图不明确(例如只说“review dependabot”),默认使用审计模式,因为它覆盖范围更广。
在分析过程中,技能会:
- 从 diff 中提取每个 gem 的名称、旧版本、新版本和升级类型(patch、minor 或 major)。
- 获取旧版本到新版本之间的变更日志,来源包括 GitHub 变更日志文件、GitHub releases 和 RubyGems.org。
- 按重要性整理发现:破坏性变更(含具体修复建议)、弃用、安全修复、值得注意的 bug 修复和新功能。
- 搜索代码库,了解 gem 涉及哪些模块、类和配置文件,并按功能领域分组描述影响。
- 检查 Gemfile 中的版本约束和分组(:development、:test 或生产环境),以及生态系统中其他 gem 的依赖兼容性。
- 给出明确的结论:Merge(安全、低风险)、Merge after verification(看起来安全但需先验证特定事项)、Investigate(需要人工判断的具体问题)或 Hold(存在破坏性变更或兼容性问题,需要先修改代码)。
使用方式
审计模式流程
- 通过
gh repo view --json nameWithOwner -q .nameWithOwner确定当前仓库,然后使用gh pr list --author "app/dependabot" --state open列出开放的 Dependabot PR。 - 对每个 PR 运行单 PR 分析流程,收集升级类型、变更日志要点和代码库影响。
- 生成合并报告,包括:简短前言、汇总表格、每个 PR 的详情小节(约 15-25 行)以及整体建议块。
- 询问用户是否将发现作为 PR 评论发布。
审计汇总表格
表格使用 GitHub 风格的 markdown,列依次为:#(PR 编号,带链接)、Gem(gem 名称,多 gem 用逗号分隔)、Bump(旧版本 → 新版本)、Type(patch/minor/major,安全公告加 🔒 前缀)、Age(自创建以来的天数)、Verdict(Merge/Verify/Investigate/Hold)、Why(不超过 10 个词的简短原因)。
排序规则:首先按结论顺序 Merge → Verify → Investigate → Hold 排列,同一结论内按 Age 降序排列。任何带 🔒 标记的行会跳到整个表格顶部,因为安全紧迫性优先于按易用性排序。
单 PR 流程
- 解析 PR URL 获取 owner、repo 和 PR 编号,使用
gh pr view和gh pr diff获取详情和差异。 - 审查变更日志和破坏性变更,重点关注旧版本到新版本之间的变化。
- 查找代码库影响,包括 Gemfile 条目、使用位置、功能映射和生态 gem 兼容性。
- 给出建议,考虑升级类型、使用范围、功能领域、变更日志和安全修复等因素。
- 询问是否将审查作为 PR 评论发布。
输出格式
单 PR 输出结构包括:标题(gem 名称和版本变化)、Bump Type、What Changed、Breaking Changes in This Codebase(如有)、Codebase Impact、Recommendation。多 gem PR 使用一个顶级标题,每个 gem 一个章节,最后给出综合建议。
发布评论
发布是公开可见的操作,因此始终先询问用户,绝不自动发布。单 PR 模式询问“yes / no”,审计模式询问“yes / no / selective”。使用 gh pr comment <NUMBER> --repo <OWNER/REPO> --body-file <path-to-tempfile> 命令发布,评论模板包含结论、一行原因、可折叠的完整审查内容,以及一个不可见的 <!-- dependabot-audit:v1 --> 标记用于幂等性检查。发布前会检查是否已有带该标记的评论,避免重复。
适用场景
该技能适用于使用 Ruby/Rails 项目并启用 Dependabot 的团队,特别是需要定期审查依赖升级 PR 的开发者。它可以帮助团队快速判断哪些升级可以安全合并、哪些需要进一步调查、哪些需要先修改代码。技能文档中提供的代码库上下文示例是一个 Rails 7.2 应用(Ruby 3.4.2),包含支付处理、认证、授权、事件流、地理计算等高风险区域,以及数据库、缓存、监控等中风险区域和测试、lint 等低风险区域。
限制
- 该技能依赖 gh 命令行工具和 GitHub 仓库访问权限。
- 变更日志的获取依赖于 gem 仓库中是否存在 CHANGELOG.md、Changes.md 或 HISTORY.md 等文件,如果找不到会明确说明。
- 不推荐运行测试套件,因为 CI 会处理;而是建议人工验证测试可能无法捕获的特定事项。
- 发布评论需要相应权限,如果失败会报告并继续,审计模式下不会因单个评论失败而中止整个批次。
- 关于收费、价格、平台支持等具体信息,资料中暂未提供。