➡️

ghコマンドでworkflow runを実行可能にするまで

に公開
GitHub Actions
初心者向け
tech

必要なこと

  • 起動したいワークフローにworkflow_dispatchイベントを定義する
  • 起動したいワークフローファイルをデフォルトブランチに取り込む

以上です。

起動したいワークフローにworkflow_dispatchイベントを定義する

https://cli.github.com/manual/gh_workflow_run

This command will trigger GitHub Actions to run a given workflow file. The given workflow file must support an on.workflow_dispatch trigger in order to be run in this way.

と記載があるように、起動させたいworkflowファイルにworkflow_dispatchイベントが定義されている必要があります。

起動したいワークフローファイルをデフォルトブランチに取り込む

https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow

To trigger the workflow_dispatch event, your workflow must be in the default branch.

と記載があるように、起動させたいworkflowファイルをリポジトリのデフォルトブランチに取り込む必要があります。

条件を満たしている場合

リポジトリのActionsページに以下のようにRun Workflowのボタンが表示されます。

この状態になればgh workflow runで該当のwfを呼び出すことができるようになります。

条件が満たされていない場合

gh workflow runした際に以下のようなエラーが表示されると思います。

could not create workflow dispatch event: HTTP 422: Workflow does not have 'workflow_dispatch' trigger

Discussion