ワークフローディスパッチAPIが実行IDを返すようになりました

GitHub ActionsのワークフローをAPI経由で起動する際、新たに実行IDなどのメタデータを応答として取得できるようになりました。これまでは、ワークフロー・ディスパッチAPIエンドポイントを使用してワークフローをトリガーすると、応答は「204 No Content」ステータスコードのみで、実際に開始されたワークフローの実行をAPI呼び出しと直接関連付けることが困難でした。 今回の変更により、API呼び出し時に新しいオプションパラメータ「return_run_details」をtrueに設定すると、応答ステータスが「200 OK」に変わり、ワークフローの実行ID、API URL、ワークフローのWeb URLを含む詳細情報が返されます。このパラメータを指定しない場合、従来通り「204 No Content」が返るため、既存の実装は影響を受けません。 この機能はGitHub CLI（バージョン2.87.0以降）でもサポートされています。「gh workflow run」コマンドでワークフローを起動すると、作成された実行のURLと、その実行を確認するための「gh run view」コマンドが自動的に表示されるようになりました。 この改善により、開発者は自身のAPI呼び出しによって開始されたワークフロー実行を容易に追跡できるようになります。これまで必要だった、大量のポーリング処理や独自の追跡システムの構築が不要となり、自動化スクリプトやCI/CDパイプラインとの連携が大幅に効率化されます。なお、最新版のGitHub CLIでは、「return_run_details」パラメータがデフォルトで有効（true）に設定されています。 要約すると、ワークフロー・ディスパッチAPIの応答に実行詳細情報を含めるオプションが追加されたことで、ワークフロー実行の可観測性と管理性が向上し、開発者体験が改善された点が主なポイントです。詳細はGitHub Actionsの公式ドキュメントで確認できます。

ワークフローディスパッチAPIが実行IDを返すようになりました

背景や根拠まで確認しますか？

関連記事

調べる

選ぶ

サイト