Zum Inhalt springen

Ruby on Rails GitHub Actions Workflow-Vorlage

Zuletzt aktualisiert am

Dies ist ein funktionierendes .github/workflows/ci.yml für eine Rails-App auf Postgres. Es cached Gems mit ruby/setup-ruby, startet einen Postgres-Service-Container, bereitet die Test-Datenbank vor und führt RuboCop und Ihre Tests aus.

Der Workflow

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

Was die nicht offensichtlichen Teile bewirken

  • ruby-version: .ruby-version liest die Version aus der Datei in Ihrem Repository, sodass CI und lokale Entwicklung nicht auseinanderlaufen. Falls Sie diese Datei nicht haben, geben Sie stattdessen eine Version wie "3.3" an.
  • bundler-cache: true führt bundle install aus und cached die Gems, mit einem Schlüssel aus Gemfile.lock und der Ruby-Version. Ein separater actions/cache-Schritt ist nicht nötig.
  • services.postgres startet Postgres neben dem Job unter localhost:5432. Die --health-*-Optionen sorgen dafür, dass GitHub wartet, bis Verbindungen angenommen werden.
  • DATABASE_URL überschreibt config/database.yml in Rails, sodass dieselbe Datei für lokale Entwicklung und CI genutzt werden kann. Der Datenbankname app_test wird durch db:create angelegt.
  • db:schema:load baut die Datenbank in einem Schritt aus db/schema.rb auf, was schneller ist, als jede Migration erneut auszuführen. Verwenden Sie db:structure:load, wenn Sie structure.sql nutzen.
  • rubocop --parallel prüft den Code auf allen Kernen. Entfernen Sie den Schritt, wenn Sie RuboCop nicht verwenden.
  • bin/rails test führt Minitest aus. Ersetzen Sie es durch bundle exec rspec, wenn Sie RSpec verwenden.

Varianten

System-Tests und JavaScript

Rails-Apps mit JavaScript benötigen Node. Fügen Sie actions/setup-node@v4 mit cache: yarn oder npm hinzu und führen Sie bin/rails assets:precompile oder yarn build vor den Tests aus. System-Tests benötigen Chrome, das auf ubuntu-latest bereits vorhanden ist.

Parallele Tests

Rails kann Tests mit parallelize(workers: :number_of_processors) in test_helper.rb parallelisieren. Für mehrere Maschinen verwenden Sie Test-Sharding und geben jedem Shard eine eigene Datenbank.

Redis oder Sidekiq

Fügen Sie einen redis:7-Service mit --health-cmd "redis-cli ping" hinzu.

Deploy-Job

Fügen Sie einen zweiten Job mit needs: test nur für main hinzu. Verwenden Sie OIDC, um auf Ihre Cloud zuzugreifen.

macOS

Für eine Server-App nicht nötig. Bleiben Sie bei Linux; Service-Container laufen nicht auf macOS-Runnern.

Auf schnelleren Maschinen ausführen

Rails-Suiten verbringen die meiste Zeit mit dem Datenbank-Setup und der Testausführung. Ändern Sie eine Zeile:

    runs-on: [self-hosted, Linux, compiler-ci]

Der Job läuft dann auf einer frischen 8-vCPU-Maschine von compiler.dev, mit automatischem Fallback. Eine vollständige Liste der Optimierungen finden Sie unter Rails auf GitHub Actions beschleunigen. Die Preise stehen auf der Preisseite.

FAQ

Warum nicht actions/cache für Gems verwenden?

bundler-cache: true erledigt das mit einem korrekten Schlüssel für Sie. Manuelles Caching vergisst oft die Ruby-Version im Schlüssel.

Meine Tests schlagen nur in der CI mit einem Verbindungsfehler fehl. Warum?

Prüfen Sie, ob der Host in DATABASE_URL localhost ist und die Health-Check-Optionen vorhanden sind.

Kann ich stattdessen MySQL verwenden?

Ja. Ersetzen Sie den Service durch mysql:8, verwenden Sie --health-cmd "mysqladmin ping" und ändern Sie das Schema in DATABASE_URL auf mysql2://.

Wie debugge ich einen Fehler?

Laden Sie log/test.log und tmp/screenshots mit if: failure() als Artefakt hoch.