GitHub PR Tool 是一个面向 GitHub Pull Request 的本地操作工具,主要用途是在 PR 正式合并之前,将其拉取到本地进行预览、合并和测试。
主要能力
工具提供四个命令:
- preview:预览一个 PR,显示 PR 标题、作者、状态、变更文件、CI 状态以及近期评论。
- fetch:将 PR 的 head 拉取到本地分支,默认分支名为 pr/<number>,可通过 --branch <name> 指定其他分支名。
- merge:拉取并合并 PR 到当前分支,可通过 --no-install 控制是否在合并后运行安装。
- test:执行完整测试流程,包括拉取、合并、安装依赖,并运行构建与测试。
使用方式
使用前需要满足两个前提条件:gh CLI 已完成认证(gh auth login),以及 Git 仓库已配置远程仓库。
命令格式如下:
github-pr preview <owner/repo> <pr-number>
github-pr fetch <owner/repo> <pr-number> [--branch <name>]
github-pr merge <owner/repo> <pr-number> [--no-install]
github-pr test <owner/repo> <pr-number>
示例:
预览来自 clawdbot 的 MS Teams PR
github-pr preview clawdbot/clawdbot 404
在本地拉取
github-pr fetch clawdbot/clawdbot 404
合并到当前分支
github-pr merge clawdbot/clawdbot 404
或执行完整测试流程
github-pr test clawdbot/clawdbot 404
适用场景
- 在 PR 被合并之前试用上游 PR。
- 将开放 PR 中的功能合并到自己的 fork。
- 在本地测试 PR 的兼容性。
限制与注意事项
- PR 默认从上游远程仓库拉取,可使用 --remote <name> 指定其他远程仓库。
- 合并冲突需要手动解决。
- test 命令会自动检测包管理器(npm/pnpm/yarn/bun)。
- 关于收费、价格、平台支持范围等信息,资料中暂未提供。