GitHub Actions、Workflow dispatchでRun IDの取得に対応
GitHub Actionsのworkflow dispatch APIエンドポイント呼び出しにおいて、対応するワークフローのメタデータの取得に対応。
主な変更点:
- 追加されたオプションパラメータ
return_run_detailsを指定することで、ワークフローID、API URL、ワークフローURLの取得が可能 - 従来の
204 No Content返却に加えて、同オプション指定時は200 OKのステータスコードとともにメタデータを返却 - メタデータの返却によってAPI呼び出しとの紐付けが容易に
- カスタムトラッキングの構築や長時間のポーリングが不要に
GitHub CLIの対応:
- v2.87.0で対応
gh workflow runによる実行時に、作成された実行結果のURLと状態確認用のgh run viewコマンドを返却- デフォルトで
return_run_detailsをtrueに設定
出展:Workflow dispatch API now returns run IDs - GitHub Changelog