できない.dev

workflow_dispatch

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

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

公開: 更新:

定義

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)が動かない で扱っている。