GitHub Actionsの同時実行グループとは?
最終更新
コンカレンシーグループとは、GitHub Actionsのワークフローまたはジョブ内にある名前付きのキーで、同じキーを持つ実行を同時に1つだけに制限する仕組みです。新しい実行は待機するか、cancel-in-progress: trueを指定した場合は、実行中の古い実行をキャンセルします。
仕組み
concurrencyブロックにgroup文字列を追加します。GitHubは実行ごとにこの文字列を評価します。同じグループの別の実行がすでに進行中の場合、新しい実行は保留状態になります。cancel-in-progressがtrueの場合は、古い実行がキャンセルされ、新しい実行がすぐに開始されます。
グループごとに保留状態にできる実行は1つだけです。1つの実行が進行中で1つが待機中のときに3つ目の実行が届くと、待機中の実行は破棄され、最新の実行が優先されます。ただし、進行中の実行をキャンセルするように設定している場合は除きます。
グループ文字列には通常、ワークフロー名とrefを組み合わせるため、ブランチやプルリクエストごとに専用のレーンが作られます。活発なプルリクエストで置き換えられた実行をキャンセルすることは、無駄になるCI分を減らす最も簡単な方法の1つです。
例
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
この例では、プルリクエストごとに専用のグループが作られ、新しいプッシュ時に古い実行がキャンセルされます。mainへのプッシュはrefごとのグループに入り、キャンセルされずにキューに入るため、mainのすべてのコミットがテストされます。
ジョブレベルでも動作します。たとえばデプロイを直列化する場合は次のとおりです。
jobs:
deploy:
concurrency:
group: production-deploy
cancel-in-progress: false
runs-on: ubuntu-latest
steps:
- run: ./deploy.sh
よくある間違い
- デプロイの途中キャンセル。途中でキャンセルされたデプロイは、インフラストラクチャを不安定な状態のまま残す場合があります。デプロイには
cancel-in-progress: falseを使用してください。 - グループの範囲が広すぎる。すべてのブランチに対して
ciのような固定文字列を使うと、無関係なプルリクエスト同士が互いの実行をキャンセルしてしまいます。 - mainの実行をキャンセル。デフォルトブランチの実行をキャンセルすると、どのコミットがビルドを壊したのかがわかりにくくなります。
- マージキューの実行をキャンセル。
merge_groupイベントからの実行はキャンセルしないでください。詳しくはマージキューを参照してください。 - ワークフロー名を省略。同じグループ文字列を持つ異なる2つのワークフローは同じレーンを共有し、互いの実行をキャンセルし合います。
関連用語
さらにコストを抑えるには、GitHub Actionsの料金を削減するを参照してください。
よくある質問
ワークフローとジョブのコンカレンシーの違いは何ですか?
ワークフローレベルのコンカレンシーは実行全体を制御します。ジョブレベルのコンカレンシーは個々のジョブを制御し、デプロイ先のような共有リソースをロックする場合に役立ちます。
cancel-in-progressでコストは削減できますか?
はい。置き換えられた実行は分数を消費しなくなります。削減効果は、オープンなプルリクエストへのプッシュ頻度によって異なります。
キャンセルされた実行は課金されますか?
キャンセルされるまでに使用した分数は課金されます。キャンセル後の分数は課金されません。
関連記事
- CI分とは? GitHub Actionsの料金の仕組みCI分とは、パイプラインが使用する課金対象のコンピュート時間です。GitHub Actionsでの分の数え方、切り上げと乗数、そして使用量を減らす方法を説明します。
- GitHub Actionsのキャッシュキーとは?キャッシュキーとは、GitHub Actionsで保存されたキャッシュを識別する文字列です。キーとrestore-keysの仕組みを理解し、古いキャッシュを避ける方法を学びましょう。
- 不安定なテストとは何か:定義と原因不安定なテストとは、コードに変更がないにもかかわらず、成功したり失敗したりするテストのことです。一般的な原因、CIでの検出方法、修正または隔離(クォランティン)の方法を解説します。
- GitHub Actionsのマトリックスビルドとはマトリックスビルドは、OSや言語バージョンなどの異なる入力で、1つのジョブを複数回実行します。構文、include/exclude、よくある間違いを学べます。