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に設定

#参考文献