GitHub ActionsでRailsを高速化する
最終更新
GitHub ActionsでRailsを高速化するには、ruby/setup-rubyでgemをキャッシュし、テストしないアセットのプリコンパイルを省き、すべてのマイグレーションを実行する代わりにスキーマファイルからデータベースを準備し、テストスイートを複数のプロセスとジョブに分割します。Rails CIの時間の多くは、起動、データベース設定、そして長い1つのプロセスでのテスト実行に費やされています。
これはRails版のGitHub Actionsを高速化する一般的なガイドです。同じ考え方はRSpecやMinitestにも当てはまります。
Rails CIで時間がかかる場所
一度ビルドを実行し、各ステップの時間を確認してください。一般的なRailsアプリでは、次の順に時間がかかります。gemのインストール(キャッシュします)、データベースのセットアップ(20〜60秒になることが多い)、システムテストがある場合のJavaScriptとアセットのビルド、そしてテストの実行そのものです。通常、テストの実行が最も長くかかります。時間の大きさではなく、対応の手間の少ない順に修正してください。
簡単な方法でgemをキャッシュする
ruby/setup-rubyはgemのインストールとキャッシュを代わりに行えます。そのREADMEによると、bundler-cache: trueを指定するとbundle installが実行され、キャッシュキーにlockfileを使ってgemが自動的にキャッシュされます。
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
ruby-versionを設定しない場合、Rubyのバージョンは.ruby-versionまたは.tool-versionsから取得されます。キャッシュされたgemセットが壊れた場合は、cache-version: 1(0以外の任意の値)を設定して作り直せます。vendor/bundle向けに2つ目のactions/cacheステップを追加しないでください。このアクションがすでに行っています。
スキーマからデータベースを準備する
新しいPostgreSQLサービスは空の状態で起動します。毎回のジョブで400件のマイグレーションを実行するのは遅く、壊れやすくなります。代わりにスキーマを読み込んでください。PostgreSQLとRedisのサービスを含む完全なジョブの例は次のとおりです。
jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 25
services:
postgres:
image: postgres:17
env:
POSTGRES_PASSWORD: postgres
ports: ["5432:5432"]
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 5s --health-timeout 5s --health-retries 10
redis:
image: redis:7
ports: ["6379:6379"]
options: >-
--health-cmd "redis-cli ping"
--health-interval 5s --health-timeout 5s --health-retries 10
env:
RAILS_ENV: test
DATABASE_URL: postgres://postgres:postgres@localhost:5432/app_test
REDIS_URL: redis://localhost:6379/0
steps:
- uses: actions/checkout@v7
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- run: bin/rails db:schema:load
- run: bundle exec rspec
db/schema.rbまたはdb/structure.sqlをコミットし、常に最新の状態に保ってください。ヘルスチェックも重要です。これがないと、PostgreSQLが接続を受け付ける前に最初のテストが実行される場合があり、不安定なテストに見えるランダムな失敗が起きます。
使い捨てのテストデータベースには永続性は必要ありません。PostgreSQLを自分で起動する場合、-c fsync=off -c synchronous_commit=off -c full_page_writes=offを指定すると書き込みの負荷を下げられます。実際のデータには決して使用しないでください。
bootsnapと起動時間
bootsnapはRubyのload pathとコンパイル済みバイトコードをキャッシュし、最近のRailsアプリのデフォルトのGemfileにも含まれています。キャッシュはtmp/cache/bootsnapに置かれますが、新しいVMでは空のため、最初の起動が遅くなります。次のようにキャッシュしてください。
- uses: actions/cache@v6
with:
path: tmp/cache/bootsnap
key: bootsnap-${{ runner.os }}-${{ hashFiles('Gemfile.lock', '.ruby-version') }}
効果はジョブごとに数秒程度です。多数の並列ジョブに分割する場合に最も効果があります。各ジョブが起動コストを支払うためです。
テストに不要な作業を省く
- アセット。コンパイル済みアセットが必要なのがシステムテストだけなら、
bin/rails assets:precompileはそのジョブでだけ実行してください。actions/setup-node経由でnode_modulesをキャッシュします。 - イーガーロード。テスト環境で
config.eager_load = ENV["CI"].present?を設定すると読み込みエラーを検出できますが、プロセスごとに起動時間が増えます。1つのジョブだけで使うことを検討してください。 - ログ。テスト環境では
config.log_level = :warnを設定してください。詳細なデバッグログは大規模なテストスイートを遅くします。 - システムテスト。ブラウザテストは専用のジョブに分け、ユニットテストやリクエストスペックを妨げないようにしてください。不安定な場合は不安定なE2Eテストを参照してください。
テストスイートを分割する
1回のbundle exec rspecは1つのプロセスで実行されます。方法は2つあります。
- 1台のマシン上の複数プロセス。
parallel_testsgemは、データベースをプロセスごとに1つ用意したうえで、CPUコアをまたいでspecファイルを実行します(parallel_rspec spec)。Railsには、Minitest向けに組み込みのparallelize(workers: :number_of_processors)もあります。 - 複数のマシンにまたがるジョブ。マトリックスを使い、記録された実行時間でファイルを分割してください。Knapsackは計測時間に基づいて負荷を分散します。
parallel_testsは、ログファイルの実行時間でグループ化することもできます。
parallel_testsのグループ化を使ったマトリックスの例です(ここでの-n 4はグループの総数です)。
strategy:
fail-fast: false
matrix:
group: [1, 2, 3, 4]
steps:
- uses: actions/checkout@v7
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- run: bin/rails db:schema:load
- run: bundle exec parallel_rspec --only-group ${{ matrix.group }} --group-by runtime -n 4 spec
グループの負荷を均等にするため、parallel_testsに実行時間のログ(tmp/parallel_runtime_rspec.log。アーティファクトまたはキャッシュとして保存できます)を渡してください。ログがない場合はファイルサイズにもとづいて分割されます。考え方の詳細はGitHub Actionsでのテストシャーディングを、シャード数の見積もりにはテストシャード計算ツールを参照してください。
コアとRails
Railsのテストは主に1プロセスで動くRubyコードのため1つのコアしか使いません。そのため、parallel_testsまたはMinitestのparallelizeでコアを使うようにしてはじめて、大きなマシンが効果を発揮します。そうすれば、8 vCPUで1つのジョブ内に8ワーカーを動かせるので、起動とインストールを毎回支払う4つのジョブに分けるより有利です。当社のベンチマークにはRailsの項目がないため、高速化の倍率は示しません。
compiler.devで自分のテストスイートを試すには、1行をruns-on: [self-hosted, Linux, compiler-ci]に変更してください。料金とランナーサイズ選択ツールもご覧ください。関連ページ:Railsテンプレート、GitHub Actionsのキャッシュ、遅いCI。
よくある質問
RailsでGitHub Actionsのgemをキャッシュするには?
bundler-cache: trueを指定してruby/setup-rubyを使ってください。gemをインストールし、Gemfile.lockを使ってキャッシュします。
Railsではparallel_testsとジョブのマトリックスのどちらが適していますか?
1台のマシンのコアを使い切るにはparallel_testsを、複数のマシンに広げるにはマトリックスを使ってください。多くのチームは両方を組み合わせています。3〜4ジョブのマトリックスで、各ジョブが複数のプロセスを実行する形です。
RailsのテストがCIでだけ不安定になるのはなぜですか?
よくある原因は次のとおりです。PostgreSQLの準備ができていないこと(ヘルスチェックを追加してください)、並列プロセス間で状態が共有されていること(プロセスごとに1つのデータベースを使ってください)、時間に依存するテストであることです。
CIではdb:migrateとdb:schema:loadのどちらを実行すべきですか?
速度のためにはスキーマを読み込んでください。マイグレーションが今も適用できることを確認するため、別の1つのチェックでマイグレーションを実行してください。
関連記事
- GitHub ActionsでTypeScriptモノレポを高速化するGitHub Actionsで TypeScriptモノレポの型チェックとリンターを高速化する: インクリメンタルtsc、プロジェクト参照、Lintキャッシュ、並列ジョブ
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- READMEにCIの速度バッジを追加するREADME のバッジで CI の速さを表示しましょう。リポジトリの GitHub Actions 実行時間の中央値が自動で更新されます。公開リポジトリは無料です。
- GitHub Actionsで.NETを高速化するGitHub Actions で .NET のビルドを高速化する: setup-dotnet による NuGet キャッシュ、--no-restore、--no-build、並列の dotnet test、SQL Server サービス。