Ruby on Rails GitHub Actions ワークフローテンプレート
最終更新
これは Postgres を使う Rails アプリ向けの動作する .github/workflows/ci.yml です。ruby/setup-ruby で gem をキャッシュし、Postgres サービスコンテナを起動し、テストデータベースを準備して、RuboCop とテストを実行します。
ワークフロー
name: CI
on:
push:
branches: [main]
pull_request:
permissions:
contents: read
concurrency:
group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 20
services:
postgres:
image: postgres:16
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
ports:
- 5432:5432
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 5s
--health-timeout 5s
--health-retries 10
env:
RAILS_ENV: test
DATABASE_URL: postgres://postgres:postgres@localhost:5432/app_test
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: .ruby-version
bundler-cache: true
- run: bundle exec rubocop --parallel
- run: bin/rails db:create db:schema:load
- run: bin/rails test
分かりにくい部分の役割
ruby-version: .ruby-versionはリポジトリのファイルからバージョンを読み込むため、CI とローカル開発のバージョンがずれることはありません。そのファイルがない場合は、代わりに"3.3"のようなバージョンを指定してください。bundler-cache: trueはbundle installを実行し、Gemfile.lockと Ruby のバージョンをキーとして gem をキャッシュします。別途actions/cacheステップを用意する必要はありません。services.postgresは、ジョブと並行してlocalhost:5432で Postgres を起動します。--health-*オプションにより、接続を受け付けるまで GitHub が待機します。DATABASE_URLは Rails のconfig/database.ymlの設定を上書きするため、同じファイルをローカルと CI の両方で使えます。データベース名app_testはdb:createによって作成されます。db:schema:loadはdb/schema.rbから一度にデータベースを構築するため、すべてのマイグレーションを順に再実行するより高速です。structure.sqlを使っている場合はdb:structure:loadを使用してください。rubocop --parallelは全コアを使って静的解析を行います。RuboCop を使っていない場合は、このステップを削除してください。bin/rails testは Minitest を実行します。RSpec を使う場合はbundle exec rspecに置き換えてください。
バリエーション
システムテストと JavaScript
JavaScript を使う Rails アプリには Node が必要です。cache: yarn または npm を指定した actions/setup-node@v4 を追加し、テストの前に bin/rails assets:precompile または yarn build を実行してください。システムテストには Chrome が必要ですが、これは ubuntu-latest にすでに含まれています。
並列テスト
Rails では test_helper.rb に parallelize(workers: :number_of_processors) を記述することでテストを並列化できます。複数のマシンを使う場合は テストシャーディング を利用し、各シャードに専用のデータベースを割り当ててください。
Redis または Sidekiq
--health-cmd "redis-cli ping" を指定した redis:7 サービスを追加してください。
デプロイジョブ
main のみを対象に、needs: test を指定した 2 つ目のジョブを追加してください。クラウドへの接続には OIDC を使用します。
macOS
サーバーアプリケーションでは不要です。Linux のままにしてください。サービスコンテナは macOS ランナーでは動作しません。
より高速なマシンで実行する
Rails のテストスイートでは、大半の時間がデータベースのセットアップとテストの実行に費やされます。次の 1 行を変更してください:
runs-on: [self-hosted, Linux, compiler-ci]
これにより、ジョブは compiler.dev の 8 vCPU の新しいマシンで実行され、自動フォールバックも行われます。チューニングの全項目については GitHub Actions で Rails を高速化する方法 を参照してください。料金は 料金ページ でご確認いただけます。
よくある質問
gem に actions/cache を使わないのはなぜですか?
bundler-cache: true を指定すると、正しいキーで自動的にキャッシュされます。手動でキャッシュを設定すると、キーに Ruby のバージョンが含まれないことがよくあります。
CI でのみ接続エラーによりテストが失敗します。原因は何ですか?
DATABASE_URL のホストが localhost になっていること、およびヘルスチェックのオプションが設定されていることを確認してください。
代わりに MySQL を使えますか?
はい、使えます。サービスを mysql:8 に置き換え、--health-cmd "mysqladmin ping" を使用し、DATABASE_URL のスキームを mysql2:// に変更してください。
失敗の原因はどのように調べればよいですか?
if: failure() を指定して、log/test.log と tmp/screenshots を アーティファクト としてアップロードしてください。
関連記事
- GitHub ActionsでRailsを高速化するGitHub ActionsでRailsのCIを高速化します。gemのキャッシュ、bootsnap、PostgreSQLとRedisのサービス、parallel_testsによる分割、アセットの扱いを解説します。動作するYAMLも掲載しています。
- .NET GitHub Actions ワークフローテンプレートNuGet のキャッシュ、リストア、ビルド、テストの手順と SQL Server サービスの選択肢、同時実行制御と権限設定を備えた、.NET 向けの GitHub Actions CI をコピーしてすぐ使えます。
- Django GitHub Actions ワークフローテンプレートPostgres サービスコンテナー、pip キャッシュ、マイグレーションの確認とテストを備え、同時実行制御と権限設定も含む、Django 向けの GitHub Actions CI をコピーしてすぐ使えます。
- DockerビルドのGitHub ActionsワークフローテンプレートBuildx、GitHubのキャッシュレイヤー、mainへのプッシュ時のGHCRへのプッシュを使ってDockerイメージをビルドする、最小限の権限で動作するGitHub Actionsワークフローのコピー&ペースト用サンプルです。