【GitHub CLI】ghコマンドでPR番号からブランチ名を取得する

GitHub CLI を用いて、PR 番号からブランチ名を取得する方法を紹介します。

動作確認バージョン

$ gh --version
gh version 2.0.0 (2021-08-24)
https://github.com/cli/cli/releases/tag/v2.0.0

PR 番号からブランチ名を取得するコマンド

gh pr view --json headRefName --jq .headRefName [<pr-number> | <url>]

実行例

$ gh pr view --json headRefName --jq .headRefName 1234
feature/foo-bar-baz
$ gh pr view --json headRefName --jq .headRefName https://github.com/cli/cli/pull/1222
api-pagination

gh version 2.0.0 からは gh extension でカスタムコマンドを追加できるようになったので、gh get-branch-name で上記と同じことができるようにしてみました。

カスタムコマンドのインストールと実行例

$ gh extension install mascii/gh-get-branch-name
$ gh get-branch-name 1234
feature/foo-bar-baz
$ gh get-branch-name https://github.com/cli/cli/pull/1222
api-pagination

活用例

PR 番号を用いてリモートブランチをローカルブランチにマージすることができます:

git merge origin/$(gh get-branch-name 1234)