GitHub CLIでIssue(イシュー)やPull-Request(プルリクエスト)にコメントがつけられるようになりました。

Git,Github

はじめに

GitHubに対する操作をコマンドラインから実行するためのコマンドとして、 GitHub CLI を愛用しています。

昔は hub コマンドを使っていましたが、 GitHub CLI がリリースされてからはこちらを使っています。

つい先日、GitHub CLIでIssue(イシュー)やプルリクエストにコメントがつけられるようになりました。

早速使ってみたいと思います。

検証環境

$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.0.18(1)-release (x86_64-apple-darwin19.5.0)

$ brew --version
Homebrew 2.7.7-32-gebcd56c
Homebrew/homebrew-core (git revision ce8c6c; last commit 2021-01-29)

Github CLIのインストール or アップグレード

まだインストールされていない場合

インストールされていない場合には、以下のコマンドを実行します。

$ brew install gh

すでにインストールされている場合

インストール済みでバージョンが古い場合はアップグレードしましょう。

バージョンを確認してみます。

$ gh --version
gh version 1.3.1 (2020-12-03)
https://github.com/cli/cli/releases/latest

最新版は 1.5 であり、このバージョンでないとIssueやPull Requestにコメントを付けられない。
そこでアップグレードを行います。

$ brew upgrade gh

正常に終了したら、再度バージョンを確認してみます。

$ gh --version
gh version 1.5.0 (2021-01-21)
https://github.com/cli/cli/releases/tag/v1.5.0

最新バージョンになりました。

Pull-Requestにコメントをつける

早速Pull-Requestにコメントを付けてみたいと思います。

コメントを付ける前に対象のPull-Requestを探す

すでに作成済みの自分が上げたプルリクを探してみます。( プライベートな情報もあるのでプルリクコメント、ブランチなどはマスキングしてあります。

# gh pr list で既存のPull-Requestを一覧表示
$ gh pr list

Showing 30 of 40 open pull requests in ********/***************

#12591   PULL_REQUEST_COMMENT_01         genzouw:feature/test
#12588   PULL_REQUEST_COMMENT_02         *************************************
#12574   PULL_REQUEST_COMMENT_03         ******************************
#12573   PULL_REQUEST_COMMENT_04         ********************************
...

次に、自分が作成したPull-Request(一覧の一番上のもの)を確認します。
コマンドにIDを指定しますが、一覧に表示されているIDの # は不要です。

$ gh pr view 12591

これに対してコメントを付けてみたいと思います。

Pull-Requestにコメントを付けてみる

コマンドのヘルプを見てみます。

$ gh pr comment --help

Create a new pr comment

USAGE
  gh pr comment [<number> | <url> | <branch>] [flags]

FLAGS
  -b, --body string   Supply a body. Will prompt for one otherwise.
  -e, --editor        Add body using editor
  -w, --web           Add body in browser

INHERITED FLAGS
      --help                     Show help for command
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

EXAMPLES
  $ gh pr comment 22 --body "This looks great, lets get it deployed."

LEARN MORE
  Use 'gh <command> <subcommand> --help' for more information about a command.
  Read the manual at https://cli.github.com/manual

下の方にコマンドの具体例が書かれています。
以下の形式でコメントを付けられるようです。

$ gh pr comment <Pull-RequestID> --body 'コメント本文'

ではコメントをポストしてみます。

$ gh pr comment 12591 --body "
# こんにちは

こんばんは

## 箇条書き

* 試してみる
* うまく行けるかな?
  1. 連番も
  2. つけられる?
"

コマンドが正常終了したら、該当のPull-Requestのページを見てみます。

正しくコメントが投稿されました! MarkDown 形式の投稿も対応しているようです。

先程実行した gh pr view コマンドでコンソールに表示しても、コメントが追記されていることが確認できます。

ひとこと

今回は Pull-Request だけに絞りましたが、 Issue(イシュー) に対してもコメントが投稿できます。
便利ですね。

Git,Github