公式発表の解説

GitHub CLIでプルリクエストの変更を待つ gh event listen

GitHubは2026年11月19日、GitHub CLIでプルリクエストの変更を待てるようになったと発表しました。gh event listenを使うと、レビューの提出など、指定したイベントが届くまで待機できます。利用にはGitHub.comでプレビュー提供中のGitHub Event Streamsへのアクセスが必要です。

このサイトはGitHubの公式サイトではありません。公式の発表を元に日本語で整理した解説で、機能・料金・提供状況は変わるため、重要な判断では必ず下の出典と公式の最新情報も確認してください。

最初に結論

プルリクエストのレビューを待つスクリプトでは、レビューが提出されたかを繰り返し問い合わせる処理を、gh event listenでイベントを待つ処理に置き換えられます。対象のプルリクエストのURLと、待ちたいイベントを指定して使います。

次のイベントを受け取ったところで後続の処理に進みたい場合は、既定の動作を使えます。指定したイベントのうち、最初に届いたものを出力すると、コマンドは終了します。イベントを待つ部分をスクリプトやエージェントの処理に組み込めるとGitHubは説明しています。

GitHubは、利用を始めるにはgh v2.105.0以降に更新するよう案内しています。あわせて、GitHub.comのEvent Streamsへのアクセスも必要です。gh eventコマンド群とEvent Streamsはプレビュー段階で、GitHubはコマンドが変更される場合があるとしています。

何が発表されたか

GitHub CLIがGitHub Event Streamsに対応しました。gh event listenを実行すると、コマンドがイベントの購読を作成し、ストリームを開きます。イベントが届くたびに行単位のJSONで出力するため、受け取った内容を後続の処理で扱えます。

待機の対象として、GitHubはレビューの提出、プルリクエストの状態の変化、ヘッドの変更、マージ競合、チェック スイートの完了を挙げています。レビューの提出はレビューに関するイベントで、状態やヘッドの変更はプルリクエスト自体の変化に関するイベントです。待ちたい作業上の節目に合わせて対象を選べます。

待ち方はオプションで変えられます。--countは複数のイベントを待つため、--followは受信を続けるための指定です。待機を打ち切る条件を設けたい場合は--timeoutを使います。受信したイベントのうち必要な項目だけを取り出すには、--jqまたは--templateを使えます。

購読を直接扱うコマンドも用意されています。gh event subscriptionに続けて、作成にはcreate、一覧表示にはlist、詳細表示にはview、削除にはdeleteを指定します。待機を始めるときの購読の作成はgh event listenに含まれます。作成済みの購読を調べたい場合は、一覧表示や詳細表示を使えます。

日本の利用者にとっての意味

すでにプルリクエストの状態を繰り返し問い合わせるスクリプトを使っているチームは、その問い合わせが何の変化を待つためにあるのかを見直せます。レビューの提出を待って処理を再開する用途なら、レビューの提出を待機対象にする形にできます。チェック スイートが完了するまで進めたくない処理なら、完了のイベントを待機対象にできます。

チェック スイートを待つ場合は、「完了したことを受け取る処理」と「受け取った内容を使う処理」を分けて整理できます。GitHubが待機対象として挙げているのはチェック スイートの完了です。後続の処理で使う項目が決まっている場合は、JSONの行から必要な項目を取り出すオプションを検討できます。

エージェントがGitHub CLIを使う場合は、既存コマンドから待機用のコマンドを見つけられるようになりました。GitHubによると、gh pr create、gh pr view、gh run view、gh run watch、gh apiが、繰り返し問い合わせる代わりにgh event listenを使うよう案内します。チームでこれらのコマンドを使っているなら、その案内が新しい待ち方を知るきっかけになります。

まずやること

使う環境のGitHub CLIのバージョンと、Event Streamsへのアクセスを確かめます。手元で試す場合も、スクリプトやエージェントに組み込む場合も、実際にghを実行する環境でv2.105.0以降を使うことを確認します。アクセスを得るための窓口として、GitHubはEvent Streamsのウェイトリストへの登録を案内しています。

公式のgh eventマニュアルか、手元で実行できるgh event --helpで、コマンドの使い方を確認します。対象のプルリクエストのURLを用意し、レビューの提出、状態の変化、チェック スイートの完了など、自分の処理が待つべきイベントを選びます。Event Streamsについては、公式ドキュメントも案内されています。

最初に届いた対象イベントで処理を進めるなら、既定の動作でイベントがJSONとして出力され、コマンドが終了することを確認します。複数のイベントを受け取ってから進む処理や、受信を続ける処理では、必要な待ち方に合わせてオプションを選びます。待機を打ち切る必要がある処理では、その指定も確認します。

スクリプトに組み込む場合は、受信したJSONのどの項目を後続の処理に渡すかも確かめます。必要な項目が絞れている場合は、--jqや--templateを使い、後続の処理が受け取る出力を確認します。使ってみた感想や意見は、GitHub Communityのディスカッションに投稿できると案内されています。

よくある疑問

gh event listenを使う前に、購読を自分で作る必要はありますか?

gh event listenが購読を作成し、そのままストリームを開きます。購読を個別に作成したり、一覧や詳細を調べたりしたい場合には、gh event subscriptionの各コマンドを使えます。

イベントの出力を、自分の処理で使う項目だけに絞れますか?

--jqまたは--templateを使うと、必要な項目を取り出せます。受信したイベントは行単位のJSONとして出力されるため、後続の処理に渡したい項目を選べます。

GitHub CLIを更新すれば使えますか?

GitHubは、gh v2.105.0以降への更新に加え、GitHub.comでプレビュー提供中のEvent Streamsへのアクセスが必要だとしています。アクセスを得るための手続きとして案内されているのは、ウェイトリストへの登録です。

出典と確認日

この記事は上の出典に書かれている内容だけを元にしています。出典の更新があったときは、出典のページを優先してください。