できない.dev

workflow_dispatch

別名: 手動トリガー / 手動実行トリガー

GitHub Actions のワークフローを画面や API から手動で起動できるようにするイベントトリガー。入力値も渡せる。

#github-actions#workflow#trigger#ci

公開:

定義

workflow_dispatch は、GitHub Actions のワークフローを手動で起動するためのイベントトリガーです。
ワークフローの on: に指定すると、Actions 画面の「Run workflow」ボタンや REST API から実行できます。

詳細

inputs を定義すると、実行時にパラメータを受け取れます。
値は github.event.inputs.<name> で参照します。

重要な制約として、「Run workflow」ボタンは対象ワークフローの定義が既定ブランチに存在するときに表示されます。
フィーチャーブランチにしか無い定義は画面に出ません。

よくある誤解

  • on: workflow_dispatch を書けばすぐ出る」:既定ブランチへマージするまで、ボタンが現れないことがあります。
  • push などと同時に書けない」:複数イベントを併記でき、手動と自動の両方を共存できます。

関連

ボタンが出ない原因は workflow_dispatch が表示されない、定時実行は schedule(cron)が動かない を参照。