Plantilla de workflow de GitHub Actions para Ruby on Rails
Última actualización
Este es un .github/workflows/ci.yml funcional para una aplicación Rails sobre Postgres. Almacena en caché las gemas con ruby/setup-ruby, inicia un contenedor de servicio de Postgres, prepara la base de datos de pruebas y ejecuta RuboCop y sus pruebas.
El flujo de trabajo
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
Qué hacen las partes menos evidentes
ruby-version: .ruby-versionlee la versión desde el archivo de su repositorio, de modo que el CI y el desarrollo local no pueden desincronizarse. Si no tiene ese archivo, escriba una versión como"3.3".bundler-cache: trueejecutabundle instally almacena las gemas en caché, usando como claveGemfile.locky la versión de Ruby. No necesita un pasoactions/cacheindependiente.services.postgresejecuta Postgres junto al job enlocalhost:5432. Las opciones--health-*hacen que GitHub espere hasta que acepte conexiones.DATABASE_URLsobrescribeconfig/database.ymlen Rails, de modo que el mismo archivo puede servir para uso local y en CI. La base de datosapp_testla creadb:create.db:schema:loadconstruye la base de datos a partir dedb/schema.rben un solo paso, más rápido que reproducir todas las migraciones. Usedb:structure:loadsi utilizastructure.sql.rubocop --parallelanaliza el código usando todos los núcleos. Elimine el paso si no usa RuboCop.bin/rails testejecuta Minitest. Sustitúyalo porbundle exec rspecsi usa RSpec.
Variantes
Pruebas de sistema y JavaScript
Las aplicaciones Rails con JavaScript necesitan Node. Añada actions/setup-node@v4 con cache: yarn o npm, y ejecute bin/rails assets:precompile o yarn build antes de las pruebas. Las pruebas de sistema necesitan Chrome, que ya está presente en ubuntu-latest.
Pruebas en paralelo
Rails puede paralelizar las pruebas con parallelize(workers: :number_of_processors) en test_helper.rb. Para varias máquinas, use particionado de pruebas (sharding) y asigne a cada partición su propia base de datos.
Redis o Sidekiq
Añada un servicio redis:7 con --health-cmd "redis-cli ping".
Job de despliegue
Añada un segundo job con needs: test solo en main. Use OIDC para conectarse a su nube.
macOS
No es necesario para una aplicación de servidor. Manténgase en Linux; los contenedores de servicio no se ejecutan en runners de macOS.
Ejecútelo en máquinas más rápidas
Las suites de Rails dedican la mayor parte del tiempo a la configuración de la base de datos y a la ejecución de pruebas. Cambie una línea:
runs-on: [self-hosted, Linux, compiler-ci]
El job se ejecutará entonces en una máquina nueva de 8 vCPU de compiler.dev, con alternativa automática. Para una lista completa de ajustes, consulte cómo acelerar Rails en GitHub Actions. Los precios están en la página de precios.
Preguntas frecuentes
¿Por qué no usar actions/cache para las gemas?
bundler-cache: true lo hace por usted con una clave correcta. El caché manual suele omitir la versión de Ruby en la clave.
Mis pruebas fallan solo en CI con un error de conexión. ¿Por qué?
Compruebe que el host de DATABASE_URL sea localhost y que estén presentes las opciones de comprobación de estado.
¿Puedo usar MySQL en su lugar?
Sí. Cambie el servicio por mysql:8, use --health-cmd "mysqladmin ping" y cambie el esquema de DATABASE_URL a mysql2://.
¿Cómo depuro un fallo?
Suba log/test.log y tmp/screenshots como artifact con if: failure().
Relacionado
- Acelere Rails en GitHub ActionsAcelere el CI de Rails en GitHub Actions: caché de gemas, bootsnap, servicios de Postgres y Redis, división con parallel_tests y assets. YAML funcional.
- Plantilla de flujo de trabajo de GitHub Actions para .NETCI de GitHub Actions para .NET listo para copiar: caché de NuGet, restauración, compilación, pruebas, servicio SQL Server, concurrencia y permisos.
- Plantilla de flujo de trabajo de GitHub Actions para DjangoCI de GitHub Actions para Django, listo para copiar y pegar: contenedor de servicio Postgres, caché de pip, comprobación de migraciones y tests.
- Plantilla de workflow de GitHub Actions para compilar DockerFlujo de trabajo de GitHub Actions para copiar y pegar: compile imágenes Docker con Buildx, capas en caché de GitHub y publique en GHCR desde main.