2022-07-02

GitHub CLI を使って一番最後にマージされた Pull Request を取得する方法

はじめに

小ネタ記事。

GitHub でソースコード管理をしていて、ふと一番最後にマージされた Pull Request(以下 PR)の情報を取得したいと思うことがあった。調べた結果 GitHub CLI( gh コマンド)を使うと楽に実現できたので紹介する。

結論

$ gh pr list --base main --state merged --limit 1

Showing 1 of XXX pull requests in ega4432/<REPOSITORY> that match your search

#PR_NUMBER  Feature/#XX を実装した！  BRANCH_NAME>

それぞれのオプションの意味は下記のようになっているため、適宜ユースケースに応じて変更すれば良い。

--base : マージされたブランチ
--limit : 取得する件数
--state : PR の状態

JSON 形式で取得したい場合

--json オプションがあるので、バリューに取得したいフィールド名を与えることで JSON 形式で取得できる。

分かりやすいように 3 件にして実行した。

$ gh pr list --state merged \
  --base main \
  --limit 3 \
  --json number,title,mergeCommit
[
  {
    "mergeCommit": {
      "oid": "abcd1234abcd1234abcd1234abcd1234abcd"
    },
    "number": 121,
    "title": "Feature/#XX を実装した！"
  },
  {
    "mergeCommit": {
      "oid": "dcba4321dcba4321dcba4321dcba4321dcba"
    },
    "number": 119,
    "title": "bug: fixed typo"
  },
  {
    "mergeCommit": {
      "oid": "abcdefghi12345678abcdefghi12345678"
    },
    "number": 118,
    "title": "docs: update README.md"
  }
]

ここで利用できるフィールドは下記となっている。

additions
assignees
author
baseRefName
body
changedFiles
closed
closedAt
comments
commits
createdAt
deletions
files
headRefName
headRepository
headRepositoryOwner
id
isCrossRepository
isDraft
labels
latestReviews
maintainerCanModify
mergeCommit
mergeStateStatus
mergeable
mergedAt
mergedBy
milestone
number
potentialMergeCommit
projectCards
reactionGroups
reviewDecision
reviewRequests
reviews
state
statusCheckRollup
title
updatedAt
url

JSON 形式で取得して jq で整形する

実は --jq オプションもある。使う場合は上記で説明した --json オプションと一緒に使う必要がある。

あまりユースケースは思いつかないが #123 title みたいに PR 番号とタイトルを結合した形式で取得するパターンを --jq オプションを使ってやってみる。

$ gh pr list --state merged \
  --base main \
  --limit 3 \
  --json number,title \
  --jq '.[] | .result = (.number|tostring) + " " + .title | .result'
121 Feature/#XX を実装した！
119 bug: fixed typo
118 docs: update README.md

そもそもの jq の使い方については下記の記事を参考にした。

まとめ

今回は、GitHub CLI を使った小ネタだった。

僕は、普段から Issue や PR の作成、PR ブランチへのチェックアウトなどは GitHub CLI でやる癖が付いているが、ここまでオプションが充実しているとは思っていなかったので、改めて発見だった。

ターミナルあるいは IDE とブラウザを行ったり来たりする手間もなくなるので GitHub CLI はおすすめだ！

参考

GitHub - cli/cli: GitHub’s official command line tool

GitHub’s official command line tool. Contribute to cli/cli development by creating an account on GitHub.

github.com

GitHub - cli/cli: GitHub’s official command line tool

GitHub CLIで始める快適GitHub生活 - Qiita

最近、GitHub CLIが便利だな〜と思ったので紹介します。この記事は以下リリース時点の情報です。Release v0.11.1 · cli/cliGitHub CLIとは？コマンドライン…

qiita.com