Zenn
📝

GitHub Actions 手動実行ワークフローでstepに実行フラグを付ける

2022/05/24に公開
GitHub Actions
tech

初めに

GitHub Actionsの手動実行ワークフローで、実行時のパラメータでstepごとに実行フラグを付けておくと、実行したいstepだけを実行できるようになります。
2021年11月10日に、GitHub Actionsの手動ワークフロー実行時の入力タイプが追加され、type: booleanが使えるようになったので、使いやすくなりました。
https://github.blog/changelog/2021-11-10-github-actions-input-types-for-manual-workflows/

実装例

  • inputsに各stepごとに実行フラグパラメータ設定。
  • 各stepでif: ${{ github.event.inputs.run_step1 == 'true' }}で実行フラグをチェック。
name: Step Run Flag

on:
  workflow_dispatch:
    inputs:
      run_step1:
        required: true 
        type: boolean
      run_step2:
        required: true 
        type: boolean
      run_step3:
        required: true 
        type: boolean

jobs:
  step-run-flag:
    runs-on: ubuntu-latest
    steps:
      - name: step1
        if:  ${{ github.event.inputs.run_step1 == 'true' }} 
        run: echo "run step1"

      - name: step2
        if:  ${{ github.event.inputs.run_step2 == 'true' }} 
        run: echo "run step2"

      - name: step3
        if:  ${{ github.event.inputs.run_step3 == 'true' }} 
        run: echo "run step3"

実行確認

  1. step2だけ✓を入れてワークフロー実行
  2. step2だけ実行されることを確認

参考

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

Discussion