GitHub Actions に待望の手動トリガーが実装されました

The GitHub Blog

GitHub Actions: Manual triggers with workflow_dispatch

概要

今まで GitHub Actions を手動で実行するには WebHook イベントや外部イベントなどを使って自前実装するしかありませんでした。¹
今回、手動で実行するためのトリガーとして workflow_dispatch イベントが実装されたので紹介します。

実装方法

on: 
  workflow_dispatch:
    inputs:
      パラメーター名:
        description: '説明'
        required: true
        default: 'デフォルト値'

workflow_dispatch を指定します。
inputs にパラメーターを設定できます。パラメーター名に日本語は使えません。
各パラメーターには required, description, default の3つの値を設定できます。いずれも省略可能です。

設定したパラメーターには ${{ github.event.inputs.パラメーター名 }} でアクセスできます。

手動トリガーが設定されると Actions タブのワークフローに This workflow has a workflow_dispatch event trigger. [Run workflow] という項目が追加され、 [Run workflow] から手動実行できるようになります。
パラメーターをここで指定します。実行ブランチも選択できるようです。

パラメーターなしサンプル

パラメーターなしで手動実行するサンプル。

コード

.github/workflows/manual.yml

name: Manual Trigger

on: [ workflow_dispatch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - run: echo Hello, world!

実行

結果

パラメーターありサンプル

パラメーターありで手動実行するサンプル。

コード

.github/workflows/manual.yml

name: Manual Trigger

on:
  workflow_dispatch:
    inputs:
      logLevel:
        required: true
        description: ログレベル
        default: warning
      tags:

jobs:
  printInputs:
    runs-on: ubuntu-latest

    steps:
    - run: |
        echo "Log level: ${{ github.event.inputs.logLevel }}"
        echo "Tags: ${{ github.event.inputs.tags }}" 

実行

結果

パラメーターなしと同じなので省略します。

---

1. GitHub Actions で手動トリガーのワークフローを作る - Qiita ↩