SuperAPI AI 工具集

validate-pr

通用与其它

查看项目

更新于 10-16 08:10

技能介绍

validate-pr 用于校验当前 Pull Request 是否符合 Marshroom 约定。

用途:在提交或检查 PR 时,确认分支名、PR 正文与状态字段与 Marshroom 的 cart 记录一致。

主要能力:

  1. 读取 ${MARSHROOM_STATE:-~/.config/marshroom/state.json} 并解析 JSON。
  2. 运行 git branch --show-current 获取当前分支名,在 cart 中查找 branchName 匹配的条目;若无匹配,提示用户不在 cart issue 分支上。
  3. 通过 gh pr view --json title,body,headRefName 获取 PR 信息。
  4. 分支名检查:PR head 分支应与 cart 条目的 branchName 一致,预期格式为 Feature/#N 或 HotFix/#N;不匹配时显示 “Branch mismatch: expected '{branchName}', got '{actual}'”。
  5. PR 正文检查:正文必须包含 close #{issueNumber};缺失时建议执行 gh pr edit --body "$(gh pr view --json body -q '.body')\n\nclose #<issueNumber>"。
  6. 状态检查:读取 cart 条目的 status;PR 创建后状态应为 "pending"。若仍为 "running",警告状态未更新并建议运行 marsh pr;若为 "soon",警告可能未运行 /start-issue。
  7. 汇总:展示每项检查的通过/失败状态;全部通过则确认 PR 有效,否则给出修复命令。

适用场景:使用 Marshroom 管理 issue 与 PR 的开发流程中,用于自动化校验 PR 是否符合约定。

限制:依赖 Marshroom state 文件与 git、gh 命令环境;具体安装方式、价格、平台支持等资料暂未提供。