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

概要

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

宛先マシンには、GitHubホステッドランナー、より大きなランナー、またはセルフホステッドランナーのいずれかを指定できます。 - ランナーに割り当てられたラベル、またはそのグループメンバーシップ、またはこれらの組み合わせに基づいてランナーをターゲットにすることができます。
1 つの文字列として、または文字列の配列として runs-on を指定できます。
文字列の配列を指定すると、指定したすべての runs-on 値に一致するすべてのランナーでワークフローが実行されます。
複数のマシンでワークフローを実行する場合は、jobs.<job_id>.strategy を使います。

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

GitHub ホステッドランナーを使うと、各ジョブは runs-on で指定したランナーイメージの新しいインスタンスで実行されます。

利用可能なGitHubホストランナーの種類は以下のとおりです。

ランナーイメージ	YAML ワークフローラベル	メモ
Windows Server 2022	`windows-latest` または `windows-2022`	`windows-latest` ラベルは現在、Windows Server 2022 ランナーイメージを使用しています。
Windows Server 2019	`windows-2019`
Ubuntu 22.04	`ubuntu-latest` または `ubuntu-22.04`	`ubuntu-latest` ラベルは現在、Ubuntu 22.04 ランナーイメージを使用しています。
Ubuntu 20.04	`ubuntu-20.04`
Ubuntu 18.04 ^[非推奨]	`ubuntu-18.04`	`ubuntu-20.04` または `ubuntu-22.04` に移行。詳しくは、こちらの GitHub のブログ記事をご覧ください。
macOS Monterey 12	`macos-latest` または `macos-12`	`macos-latest` ラベルは現在、macOS 12 ランナーイメージを使用しています。
macOS Big Sur 11	`macos-11`
macOS Catalina 10.15 ^[非推奨]	`macos-10.15`	`macOS-11` または `macOS-12` に移行。詳しくは、こちらの GitHub のブログ記事をご覧ください。

注: -latest ランナーイメージは、GitHub が提供する最新の安定したイメージであり、オペレーティングシステムベンダーから入手できるオペレーティングシステムの最新バージョンではない可能性があります。

警告: ベータ版および非推奨のイメージは、"現状のまま"、"保証なし"、"利用可能な状態" で提供され、サービスレベルアグリーメントと保証から除外されます。ベータ版のイメージは、カスタマーサポートでカバーされない場合があります。

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

runs-on: ubuntu-latest

詳細については、「GitHub ホステッドランナーの概要」を参照してください。

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

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

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

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

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

runs-on: [self-hosted, linux]

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

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

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

ランナーグループは、より大きなランナーまたはセルフホステッドランナーのみをメンバーとして持つことができます。

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

この例では、Ubuntu 16 コアランナーが 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@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

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

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

この例では、ubuntu-runners というランナーグループに、ラベル ubuntu-20.04-16core も割り当てられている Ubuntu 16 コアランナーが設定されています。 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@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v