GitHub Actionsの手動実行 workflow_dispatchの挙動解説

経緯

GitHub Actionsでよく利用するイベントの一つにworkflow_dispatchがある。
自分への備忘録を兼ねて挙動を解説しておく。

• 用意したコード

name: Greeting

on:
  workflow_dispatch:
    inputs:
      greeting:
        type: string
        description: "The greeting to use"
        required: true
        default: "Hello, world!"

jobs:
  greeting:
    runs-on: ubuntu-latest
    steps:
      - name: Greeting
        run: echo "${{ inputs.greeting }}"

実行した際に簡単な挨拶を返す。
手入力によって挨拶の内容を改変できるという最低限シンプルなものを用意した。
git add してcommitしてpush,実行して挙動を確認していく。

早速ワークフローがコンソールに追加されていることがわかる。

右上の「Run workflow」をクリックすると、画像のようなモーダルが表示される。
yamlに記載した通り、文字列型で手入力を求められ、テキストボックスにはデフォルトで「Hello, world!」が入っている。

内容をHello, World!→Guten tag!に改変し、「Run workflow」をクリック。

無事ワークフローが実行されることが表示される。

ワークフロー実行が完了した表示。クリックして内容を確認する。

Guten tag!の挨拶が意図知った通りに表示されている。
検証完了。