■ はじめに

Self-hosted runner が各環境（e.g. dev/stage/prod）にあり
動的に変更したいってことを考える。

なお、以下のサイトが参考になった。

https://zenn.dev/snowcait/articles/56fad93b7dc95e

【１】案１：ファイルを分けて管理する
　１）デメリット
【２】案２：workflow_dispatch.inputs で指定
　１）デメリット
　２）サンプル
【３】案３：条件分岐（真or偽）で切り替える
　１）デメリット
　２）サンプル
【４】案４：Reusable Workflows を利用する
　１）デメリット
　２）サンプル

【１】案１：ファイルを分けて管理する

* 例えば「dev.workflow.yml」「prod.workflow.yml」って
　感じで分ける

１）デメリット

[1] ファイルが増える
[2] 同じ処理を別々のファイルに書くためメンテナンス性が下がる

【２】案２：workflow_dispatch.inputs で指定

構文

runs-on: ${{ inputs.<変数> }}
# or
runs-on: ${{ github.event.inputs.<変数> }}
# or
runs-on: ${{ fromJSON(github.event.inputs.<変数>) }}

１）デメリット

* 手動でデプロイする運用ならいいが、
　それ以外（自動化）は不可

２）サンプル

name: DemoWorkflow

on:
  workflow_dispatch:
    inputs:
      runs_on:
        type: choice
        default: ubuntu-latest
        options:
        - ubuntu-latest
        - ubuntu-24.04
        - ubuntu-20.04
jobs:
  demo_job:
    runs-on: ${{ inputs.runs_on }}
    steps:
      - uses: actions/checkout@v4
      - name: settings
        run: |
          echo "Hello, world"

【３】案３：条件分岐（真or偽）で切り替える

* 三項演算子を利用する

https://stackoverflow.com/questions/73241812/how-to-dynamically-assign-the-runs-on-value-in-the-github-actions

* Github Actions の 三項演算子についての詳細は、以下の関連記事を参照のこと

Github Actions ～三項演算子～
https://dk521123.hatenablog.com/entry/2024/06/20/234016

構文

    runs-on: >-
      ${{
        【条件】
          && 【条件が真の場合】
          || 【条件が偽の場合】
      }}

１）デメリット

* 条件が増えると可読性が下がる

２）サンプル

例１：ブランチで切換

name: demo for multiple runners

on:
  push:
    branches:
      - dev
      - prod

jobs:
  demo-job1:
    # if affected branch is 'demo' then runs on 'ubuntu-latest' else self-hosted...
    runs-on: >-
      ${{
        github.ref_name == 'dev'
          && fromJSON('[ "ubuntu-latest", "development" ]')
          || fromJSON('["self-hosted", "production" ]')
      }}
    steps:
      - name: Demo sample
        run: echo "Hello, world!!"

例２：３通り

name: StartA

on:
  push:

jobs:
  test:
    runs-on: >-
      ${{
        github.ref_name == 'prod'
          && fromJSON('[ "ubuntu-latest" ]')
          || (github.ref_name == 'stage' && fromJSON('["ubuntu-24.04" ]')
          # 4通りなら、、、
          # || (github.ref_name == 'dev' && fromJSON('["ubuntu-24.04" ]')
          || fromJSON('["ubuntu-20.04" ]'))
      }}
    steps:
      - name: test
        run: echo "Hi!!"

例３：複数条件

name: DemoWorkflow

on:
  workflow_dispatch:
    inputs:
      env:
        type: choice
        default: dev
        options:
        - dev
        - stage
        - prod
jobs:
  demo_job:
    runs-on: >-
      ${{
        # (【条件１（github.ref_name == 'develop'）】 &&（かつ） 【条件２（inputs.env == 'dev'）】)
        (github.ref_name == 'develop' && inputs.env == 'dev')
          && fromJSON('[ "ubuntu-20.04" ]')
          || ((github.ref_name != 'develop' && inputs.env == 'dev') && fromJSON('["ubuntu-24.04" ]')
          || fromJSON('["ubuntu-latest" ]'))
      }}
    steps:
      - uses: actions/checkout@v4
      - name: settings
        run: |
          echo "Hello, world"

例４：手動実行＆Pushイベント混合

name: TestA

on:
  workflow_dispatch:
    inputs:
      runs_on:
        type: choice
        default: ''
        options:
        - ubuntu-24.04
        - ubuntu-20.04
  push:
    branches:
      - develop
jobs:
  sample:
    runs-on: >-
      ${{
        inputs.runs_on != ''
          && inputs.runs_on
          || (github.ref_name == 'develop' && fromJSON('["ubuntu-latest"]')
          || fromJSON('["ubuntu-24.04"]'))
      }}
    steps:
      - name: Demo sample
        run: echo "Hello, world!!"

【４】案４：Reusable Workflows を利用する

Reusable Workflows の引数に設定する runs-on の値を
当たすようにする方法。（まずは、以下のサンプルをみた方がいいかも）
 => Reusable Workflowsについては、以下の関連記事を参照のこと

Github Actions ～ workflow_run / workflow_call ～
https://dk521123.hatenablog.com/entry/2024/02/14/232546

１）デメリット

* はじめに、Reusable Workflows に渡す引数を決めるために
　runs-onを固定しなくてはならない

２）サンプル

.github/workflows/start.yml

name: StartDemo

on:
  push:

jobs:
  init:
    # ★デメリット：まずは固定する必要がある
    runs-on: "ubuntu-latest"
    steps:
      # ★ここで値を決める
      - name: set for dev
        if: github.ref_name == 'develop'
        run: |
          value="ubuntu-24.04"
          echo "GITHUB_RUNS_ON=${value}" >> $GITHUB_ENV
      - name: set for stage
        if: github.ref_name == 'stage'
        run: |
          value="ubuntu-22.04"
          echo "GITHUB_RUNS_ON=${value}" >> $GITHUB_ENV
      - name: set for prod
        if: github.ref_name == 'prod'
        run: |
          value="ubuntu-latest"
          echo "GITHUB_RUNS_ON=${value}" >> $GITHUB_ENV
      # ★ここで、最終的な値を outputs に設定する
      - name: set value
        id: set-value
        run: |
          echo "ref_name = ${{ github.ref_name }}"
          echo "GITHUB_RUNS_ON = ${{ env.GITHUB_RUNS_ON }}"
          echo "github_runs_on=${{ env.GITHUB_RUNS_ON }}" >> $GITHUB_OUTPUT
    outputs:
      github_runs_on: ${{ steps.set-value.outputs.github_runs_on }}
  call_demo_workflow:
    needs: init
    uses: ./.github/workflows/reusable.yml
    with:
      # ★ここで、runs-onの値を渡す
      runs_on: ${{ needs.init.outputs.github_runs_on }}

.github/workflows/reusable.yml

name: reusable

on:
  workflow_call:
    inputs:
      # ★引数としてもらってくる
      runs_on:
        description: runs on
        default: ubuntu-latest
        type: string

jobs:
  greeting:
    # ★引数でもらってきた値をそのまま設定する
    runs-on: ${{ inputs.runs_on }}
    steps:
      - id: message
        run: |
          echo "Hello world..."

プログラムの超個人的なメモ

Memo for Programming.

【Github】Github Actions ～ runs-onを動的変更することを考える～

■ はじめに

目次

【１】案１：ファイルを分けて管理する

１）デメリット

【２】案２：workflow_dispatch.inputs で指定

１）デメリット

２）サンプル

【３】案３：条件分岐（真or偽）で切り替える

１）デメリット

２）サンプル

【４】案４：Reusable Workflows を利用する

１）デメリット

２）サンプル

関連記事