【github action】workflow_dispatchとは

 

github actionの勉強中

 

github actionには、いつワークフローを実行するかのタイミングを決める

 

Onイベントがある

 

よく使うのは

 

on: push

on: pull_request

 

の2つだと思う

 

pushをした時に自動でワークフローが実行されるのは便利

pull_requestで実行されるのはCIとしては当然だし

でも、時としてこちらの実行したタイミングでしか、ワークフローを動かしたくない処理もある

そんな時は

 

on: workflow_dispatch

 

を使えば、こちらの意図したタイミングでワークフローを実行できる!!

 

テストとして、以下のymlをgithubに上げてみる

 

name: ディスパッチのテスト

on: workflow_dispatch


jobs:

dispatch_test:

runs-on: ubuntu-latest

steps:

- name: ディスパッチのテスト1

run: echo "ディスパッチのテスト"

 

 

これは見ての通り、ただechoしているだけのymlです。

大事なのはタイミング

「on: workflow_dispatch」

となっているので、こちらの好きなタイミングでechoさせる事が出来ます。

動かす方法は

 

github管理画面⇒actionの左メニューのworkflowを選択⇒「ディスパッチのテスト」を選択

すると

「This workflow has a workflow_dispatch event trigger.」

と表示される右に「Run workflow」というボタンがあるので、クリックするとワークフローが実行される!!

 

Run echo "ディスパッチのテスト"

ディスパッチのテスト

 

と表示されているのがわかる!

「workflow_dispatch」

というのは、自分のタイミングでgithub actionを実行させる事が出来るonイベントの事でした!!

コメント