GitHub CLIでプルリクレビューを少し楽にする

GitHub CLI ご存知ですか？

私はこの前存在を知りました。
まだ現時点でベータ版ですが、なかなかに便利なので、ほぼ毎日利用しています。

プルリクエスト上で、レビューを行うチームであれば、一度使ってみてもいいと思います。

今回は、

• 人のプルリクをレビューする場合
• 自分がプルリクを出す場合

にわけて、実際にやるであろう流れで書いていこうと思います。

まずインストール

macの場合は、brewでインストールするだけです。

$ brew install github/gh/gh

他OSは、環境別のインストール手順を参考にしてください。

人のプルリクをレビューする場合

だれかから、何かしらの手段で、プルリクのレビュー依頼が飛んでくるかと思います。(slack通知や、声かけられたなど)
まず今出ているプルリクの一覧を確認してみます。
以下のコマンドで、ステータスが open なプルリクが確認できます。

$ gh pr list

Showing 1 of 1 pull request in TARO-YAMADA/gitcli-sample

#2  Add Fuga module  feature/add_fuga_module
#1  Add Hoge         feature/add_hoge

プルリクの内容を知りたいので、確認してみます。webに飛んじゃいましょう。 ¹
以下のコマンドで該当のプルリクページがブラウザで開きます。

$ gh pr view 2 --web
Opening https://github.com/... in your browser.

プルリクの内容を確認したところで、実際に手元でビルドして動かしてみたいので、該当のブランチを落としましょう。
以下のコマンドのようにプルリク番号で指定すれば、勝手にfetchしてくれて、ブランチを切り替えてくれます。
わざわざブラウザからプルリクのブランチ名を確認、コピペして。。。などは必要ありません。

$ gh pr checkout 2
Switched to a new branch 'feature/add_fuga_module'

自分がプルリクを出す場合

ブランチを切って開発し、コミットまで済んだとしましょう。
以下のコマンドで、現在のブランチのプルリク作成画面をwebで開くことができます。 ²

$ gh pr create --web

まとめ

いつもやってる作業が少し楽になった気がします。
スクリプトやaliasなどで、ある程度楽にしている人もいるかもしれませんが、公式の機能として提供されているので、私には安心感があります。

おまけ(複数アカウントは無理)

$ gh pr list
not found

ん？？？
何がnot foundやねん、githubのweb上にはあるのに。
と思ってあれこれしてたら、どうやら最初にコマンドを打ったときに認証するんですが、
別のアカウントのリポジトリのプルリクを確認しようとしていたので、not foundが出ていたようです。

現状はアカウントを切り替えたり、再認証する機能がないようで、設定ファイルを消すぐらいしかなさそうです。 ³
リリース版で対応されることを祈りましょう。。

1. ターミナル上で内容の出力もできますが、流石に描画はwebに勝てないのと、長いと全て出力されないので、あくまで概要をみるぐらいかな。 ↩

2. これもオプションでtitile, bodyなどを指定してcliでプルリクを作成できるけど、自動化などの用途以外ではあまり使わなそう。 ↩

3. このようなissueがいくつかでてる。 ↩