gh pr create 是什么
gh 是 GitHub 官方的命令行工具,gh pr create 用于在命令行直接创建拉取请求。它支持指定基分支、标题与正文、草稿状态、评审人与指派对象,未推送的分支会提示你先推送。把创建动作放进脚本后,发布流程可以少一次浏览器切换,也便于在 CI 中自动开单。适用于 GitHub 与 GitHub Enterprise,需要先 gh auth login 完成认证。
基本信息
| 用途 | 命令行创建 PR |
|---|---|
| 常用参数 | --base 基分支、--title/--body、--draft、--reviewer、--assignee |
| 快捷参数 | --fill 用提交信息填充标题与正文 |
| 前置条件 | 当前分支已推送、gh 已完成认证 |
| 平台 | GitHub 与 GitHub Enterprise |
典型使用场景
- 提交推送后立即开 PR,不用切到网页操作
- 脚本或 CI 中批量建单,配合模板统一描述格式
- 先建草稿(--draft)收集早期反馈,再转正式评审
- 用 --fill 从分支首个提交标题快速起稿,再补验证说明
- 跨版本仓库显式指定 --base,把改动提交到正确的目标分支
- 把建单步骤写进发布脚本,让提交与开单一气呵成
常用示例
常用示例
gh auth login # 首次使用先认证
git push -u origin feature/login # 分支先推到远端
gh pr create --base main --title 'feat: 支持邮箱登录' \
--body-file .github/PULL_REQUEST_TEMPLATE.md
gh pr create --fill --draft # 用提交信息填充并建为草稿
gh pr view --web # 打开刚创建的 PR
gh pr status # 查看与当前分支相关的 PR常用参数速查
| 参数 | 作用 |
|---|---|
| --base | 指定目标基分支,默认取仓库默认分支 |
| --title/--body | 直接给出标题与正文,正文可用 --body-file 读文件 |
| --draft | 创建为草稿,评审就绪后再转正 |
| --reviewer | 指定评审人,可重复传参或带团队名 |
--fill 直接用分支首个提交标题作 PR 标题,配合提交规范效率很高,但变更说明与验证步骤仍需人工补齐,否则评审者要自己猜改动意图。
正文用 --body-file 引用仓库里的 PULL_REQUEST_TEMPLATE.md,可以把「背景、改动、验证、风险、关联项」这套结构固定下来,比每次现敲更省事,也更少漏项。
创建后常做的跟进
- gh pr view --web 在浏览器里核对渲染效果与目标分支
- gh pr checks 查看 CI 状态,红了先修再请人评审
- gh pr edit 补评审人或修改标题正文
- 合并后及时删除远端分支,保持分支列表干净