🎃

Github actions の手動実行時にパラメータを渡す

2022/08/03に公開約1,200字

案件でgithub actionsをpushした時などではなく、手動で実行するときにパラメータを渡す必要があったので調べた。
記事に関しては、以下の二つを参照させてもらった。

https://zenn.dev/hankei6km/articles/use-github-acions-workflow-dispatch-inputs-safely
https://itneko.com/github-actions-choice-boolean/

まずは全体像

name: Test
on:
  workflow_dispatch:
    inputs:
      flag:
        type: boolean
        required: true
        description: "Flag data"
      choice:
        type: choice
        required: true
        options:
          - ""
          - "dir1"
          - "dir2"
          - "dir3"

jobs:
  simple-print:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Print inputs
        run: |
          echo "flag: ${{ github.event.inputs.flag }}"
          echo "option: ${{ github.event.inputs.choice }}"

onでworkflowを実行するタイミングを設定するが今回は手動実行するのでworkflow_dispatchを設定する。

https://docs.github.com/ja/actions/using-workflows/events-that-trigger-workflows#workflow_call

on.workflow_dispatch.inputsで手動実行時にパラメータを渡すことができる

https://docs.github.com/ja/enterprise-cloud@latest/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_dispatchinputs

このようにinputsを設定すると以下のようにworkflowの手動実行時にUIが表示される。
image

設定した値はjobs以下で実行しているように取得することができる。

Discussion

ログインするとコメントできます