Pull Request の番号を取得する¶

GitHub Actions から Pull Request にコメントをする際などに Pull Request の番号を取得したい。それを実現する方法についてメモを残す。

gh CLI を使う¶

gh CLI を使うと Pull Request の番号を取得できる。

1

gh pr view --json number --jq .number

--json オプションで出力を JSON 形式にし、--jq オプションで JSON の値を取得する。

GitHub Actions 内のコンテキストから取得する¶

GitHub Actions 内で Pull Request の番号を取得するには github.event コンテキストを使う。

1
2
3

export PR_NUMBER="${{ github.event.pull_request.number || github.event.issue.number }}"
# or
export PR_NUMBER="${{ github.event.number }}"