ワークフローでのセルフホストランナーの利用

リポジトリで使用可能なランナーの表示

リポジトリに repo: write アクセス許可を持つ場合は、リポジトリで使用できるランナーの一覧が表示されます。

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [アクション] をクリックします。
左サイドバーの [管理] セクションで、[ランナー] をクリックします。
ランナー一覧の上部にある [セルフホステッド] タブをクリックします。
リポジトリで使用可能なセルフホステッドランナーの一覧を確認します。この一覧には、セルフホステッドランナーおよび、Actions Runner Controller で作成されたランナースケールセットが含まれます。詳しくは、「Actions Runner Controller」をご覧ください。
必要に応じて、ランナーのラベルをコピーしてワークフローで使用するには、ランナーの右側にあるをクリックし、[ラベルのコピー] をクリックします。

メモ

Enterprise と organization の所有者は、このページからランナーを作成できます。新しいランナーを作成するには、ランナーの一覧の右上にある [新しいランナー] をクリックして、リポジトリにランナーを追加します。

詳細は、「より大きなランナーを管理する」および「自己ホストランナーの追加」を参照してください。

デフォルトラベルを使ったジョブの転送

セルフホストランナーは、GitHub Actionsに追加されたときに特定のラベルを自動的に受信します。それらは、ランナーのオペレーティングシステムとハードウェアプラットフォームを示すために使われます。

self-hosted: セルフホステッドランナーに適用される既定のラベル。
linux、windows、または macOS: オペレーティングシステムに応じて適用されます。
x64、ARM、または ARM64: ハードウェアアーキテクチャに応じて適用されます。

ワークフローのYAMLを使って、これらのラベルの組み合わせに対してジョブを送信できます。この例では、3つのラベルすべてにマッチするセルフホストランナーが、ジョブを実行する資格を持つことになります。

runs-on: [self-hosted, linux, ARM64]

self-hosted - セルフホステッドランナー上でこのジョブを実行します。
linux - Linux ベースのランナーのみを使います。
ARM64 - ARM64 ハードウェアベースのランナーのみを使います。

既定のラベルを付けずにそれぞれのセルフホステッドランナーを作成するには、ランナーを作成するときに --no-default-labels フラグを渡します。アクションランナーコントローラーは、複数のラベルをサポートしていません。

カスタムラベルを使ったジョブの転送

カスタムラベルを作成し、セルフホストランナーに割り当てることがいつでもできます。カスタムラベルを使えば、付けられたラベルに基づいて特定の種類のセルフホストランナーにジョブを送信できるようになります。

たとえば、特定の種類のグラフィックハードウェアを必要とするジョブがある場合、gpu というカスタムラベルを作成し、そのハードウェアが組み込まれているランナーに割り当てることができます。割り当てられたすべてのラベルにマッチするセルフホストランナーが、そのジョブを実行できるようになります。

以下の例は、デフォルトとカスタムのラベルを組み合わせたジョブです。

runs-on: [self-hosted, linux, x64, gpu]

self-hosted - セルフホステッドランナー上でこのジョブを実行します。
linux - Linux ベースのランナーのみを使います。
x64 - x64 ハードウェアベースのランナーのみを使います。
gpu- このカスタムラベルは、GPU ハードウェアが組み込まれたセルフホステッドランナーに手動で割り当てられました。

これらのラベルは累積的に働くので、このジョブを処理できるセルフホストランナーには、4 つすべてのラベルがなくてはなりません。

グループを使用したジョブのルーティング

この例では、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