GitHub Actionsのランナーとは
最終更新
GitHub Actionsのランナーとは、ワークフローの1つのジョブを実行するマシンのことです。仮想マシンの場合も物理マシンの場合もあります。GitHubは、ジョブのruns-onの値に一致するラベルを持つランナーを選び、そのランナー上でジョブのステップを実行して、結果を報告します。
仕組み
ワークフローがトリガーされると、各ジョブはruns-onのラベルとともにキューに入ります。それらすべてのラベルを持ち、待機中のランナーがそのジョブを取得します。ランナーはステップに必要なアクションをダウンロードし、各ステップを順番に実行して、ログをGitHubにストリーミングします。最後に成功か失敗かを報告します。
ジョブ同士はマシンを共有しません。同じワークフロー内の2つのジョブは別々のランナーで実行されるため、アーティファクトまたはキャッシュとして渡さない限り、あるジョブのファイルは次のジョブから見えません。
一般的なランナーの種類は3つあります。
- GitHubホステッドランナー:GitHubがジョブごとに作成し、実行後に削除する仮想マシンです。
ubuntu-latest、windows-latest、macos-latestなどのラベルがあります。 - ラージランナー:CPUとRAMを増強したGitHubホステッドマシンです。分単位で課金され、料金は高くなります。
- セルフホステッドランナー:お客様またはプロバイダーが運用するマシンで、独自のカスタムラベルで照合されます。
各ランナーは課金の単位でもあります。ジョブがランナーを占有している1分ごとに、CI分として加算されます。
例
jobs:
test:
runs-on: ubuntu-latest # GitHub-hosted, 2-core
steps:
- uses: actions/checkout@v4
- run: npm ci && npm test
build:
runs-on: [self-hosted, Linux, compiler-ci] # matched by labels
steps:
- uses: actions/checkout@v4
- run: make build
よくある間違い
- 状態が保持されると想定してしまう。ホステッドランナーは、ジョブが終わるたびに初期化されます。後で使いたいものは、キャッシュするかアップロードしておく必要があります。
- ラベルのタイプミス。ラベルに一致するランナーがない場合、ジョブはタイムアウトするまでキューに待機したままになります。スペルと大文字・小文字を確認してください。
- デフォルトで最大のランナーを使う。大きいマシンが効果を発揮するのは、ジョブが実際にCPUに依存している場合だけです。まずランナーサイズの選択で測定してください。
- ジョブの実行時間の上限を無視する。ジョブには最大実行時間があります。詳しくはGitHub Actionsの時間制限をご覧ください。
ジョブの実行が遅い場合、より高速なランナーに変えるのが最も手軽な解決策です。ワークフローを変更する必要がないためです。高速ランナーのガイドでは選択肢を比較しています。compiler.devでは、YAMLを1行追加するだけで既存のジョブを8 vCPUのマシンで実行できます。料金をご覧ください。
関連用語
よくある質問
ランナーとワークフローは同じものですか?
いいえ。ワークフローは何を行うかを定義するYAMLファイルで、ランナーはそれを実行するマシンです。1つのワークフローで、ジョブごとに1つずつ、複数のランナーを使うことができます。
1つのランナーで複数のジョブを同時に実行できますか?
標準のランナーは一度に1つのジョブを実行します。並列のジョブにはそれぞれ別のランナーが割り当てられます。セルフホステッド環境によっては1台のホストで複数のランナープロセスを起動することもありますが、それぞれが1つのジョブだけを実行します。
ubuntu-latestでは何が使えますか?
GitHubホステッドのLinux仮想マシンが使えます。サイズはリポジトリの種類やプランによって異なるため、スペックを前提にする前に、GitHubの最新のランナーリファレンスをご確認ください。
関連記事
- CI分とは? GitHub Actionsの料金の仕組みCI分とは、パイプラインが使用する課金対象のコンピュート時間です。GitHub Actionsでの分の数え方、切り上げと乗数、そして使用量を減らす方法を説明します。
- GitHub Actionsのキャッシュキーとは?キャッシュキーとは、GitHub Actionsで保存されたキャッシュを識別する文字列です。キーとrestore-keysの仕組みを理解し、古いキャッシュを避ける方法を学びましょう。
- GitHub Actionsの同時実行グループとは?concurrency group は、キーごとに GitHub Actions のワークフローまたはジョブを一度に 1 つだけ実行させ、古い実行をキャンセルできるようにします。YAML の例と、よくある間違いを参照してください。
- 不安定なテストとは何か:定義と原因不安定なテストとは、コードに変更がないにもかかわらず、成功したり失敗したりするテストのことです。一般的な原因、CIでの検出方法、修正または隔離(クォランティン)の方法を解説します。