ジョブのランナーを選択する

注: GitHub ホステッドランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

概要

jobs.<job_id>.runs-on を使って、ジョブを実行するマシンの種類を定義します。

宛先マシンは、セルフホステッドランナーにすることができます。 - ランナーに割り当てられたラベル、またはそのグループメンバーシップ、またはこれらの組み合わせに基づいてランナーをターゲットにすることができます。
runs-on は次として指定できます。
- 1 つの文字列
- 文字列を含む 1 つの変数
- 文字列の配列、文字列を含む変数、または両方の組み合わせ
- またはキーをkey: value使用するgroupペアlabels
文字列または変数の配列を指定すると、指定された runs-on 値の全部に一致するランナー上でワークフローが実行されます。たとえば、ここでは、ラベル linux、x64、gpu が付いているセルフホステッドランナー上でのみジョブが実行されます。
```
runs-on: [self-hosted, linux, x64, gpu]
```
詳細については、「セルフホステッドランナーの選択」を参照してください。

配列内で文字列と変数を混在させることができます。次に例を示します。

on:
  workflow_dispatch:
    inputs:
      chosen-os:
        required: true
        type: choice
        options:
        - Ubuntu
        - macOS

jobs:
  test:
    runs-on: [self-hosted, "${{ inputs.chosen-os }}"]
    steps:
    - run: echo Hello world!

複数のマシンでワークフローを実行する場合は、jobs.<job_id>.strategy を使います。

注: 引用符は、self-hosted のような単純な文字列に関しては必須ではありませんが、 "${{ inputs.chosen-os }}" などの表現には必要です。

OS (YAML ワークフローラベル)	ノート
`ubuntu-latest`、`ubuntu-22.04`、`ubuntu-20.04`	`ubuntu-latest` ラベルは現在、Ubuntu 22.04 ランナーイメージを使用しています。
`windows-latest`、`windows-2022`、`windows-2019`	現在、`windows-latest` ラベルでは、Windows 2022 ランナーイメージが使われています。
`macos-latest`、`macos-14` [ベータ]、`macos-13`、`macos-12`、`macos-11`	現在、`macos-latest` ワークフローラベルでは、macOS 12 ランナーイメージが使われています。

セルフホステッドランナーの選択

ジョブにセルフホステッドランナーを指定するには、ワークフローファイルでセルフホステッドランナーのラベルを使って runs-on を設定します。

すべてのセルフホステッドランナーに self-hosted ラベルが含まれます。このラベルのみを使うと、セルフホステッドランナーが選ばれます。オペレーティングシステムやアーキテクチャなど、特定の条件を満たすランナーを選ぶには、self-hosted で始まり (リストの最初にこれを示す必要があります)、必要に応じて追加のラベルを含むラベルの配列を指定することをお勧めします。ラベルの配列を指定すると、指定したラベルをすべて持つランナーのキューにジョブが入れられます。

self-hosted ラベルは必須ではありませんが、セルフホステッドランナーを使う場合は、自分のジョブから現在または将来の GitHub ホストランナーが意図せずに指定されないことを確実にするため、それを指定することを強くお勧めします。

例: ランナー選択のためのラベルの使用

runs-on: [self-hosted, linux]

詳細については、「セルフホステッドランナーの概要」および「ワークフローでのセルフホストランナーの利用」を参照してください。

グループ内のランナーを選ぶ

runs-on を使用してランナーグループをターゲットにして、そのグループのメンバーである任意のランナーでジョブが実行されるようにすることができます。よりきめ細かく制御するには、ランナーグループとラベルを組み合わせることもできます。

例: グループを使用してジョブの実行場所を制御する

この例では、Ubuntu ランナーが ubuntu-runners というグループに追加されています。 runs-on キーは、ubuntu-runners グループ内の使用可能なランナーにジョブを送信します。

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on: 
      group: ubuntu-runners
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

例: グループとラベルの組み合わせ

グループとラベルを組み合わせる場合、ランナーはジョブを実行する資格を得るために両方の要件を満たす必要があります。

この例では、ubuntu-runners というランナーグループに、ラベル ubuntu-20.04-16core も割り当てられている Ubuntu ランナーが設定されています。 runs-on キーは group と labels を組み合わせて、ラベルが一致するグループ内の使用可能な任意のランナーにジョブがルーティングされるようにします。

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on:
      group: ubuntu-runners
      labels: ubuntu-20.04-16core
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

例: プレフィックスを使用してランナーグループを区別する

たとえば、Organization 内に my-group という名前のランナーグループがあり、Enterprise 内に my-group という名前のランナーグループがある場合は、ワークフローファイルを更新して、org/my-group または ent/my-group を使用して 2 つを区別できます。

org/の使用

runs-on:
  group: org/my-group
  labels: [ self-hosted, label-1 ]

ent/の使用

runs-on:
  group: ent/my-group
  labels: [ self-hosted, label-1 ]

概要

GitHub ホステッドランナーの選択

例: オペレーティングシステムの指定