Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para Elixir

Última actualización

Este es un .github/workflows/ci.yml funcional para una aplicación Elixir o Phoenix con Postgres. Instala Erlang/OTP y Elixir con erlef/setup-beam, guarda en caché deps y _build, comprueba el formato, compila con las advertencias tratadas como errores y ejecuta mix test.

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:
      MIX_ENV: test
      DATABASE_URL: ecto://postgres:postgres@localhost:5432/app_test
    steps:
      - uses: actions/checkout@v4

      - uses: erlef/setup-beam@v1
        id: beam
        with:
          otp-version: "27"
          elixir-version: "1.18"

      - uses: actions/cache@v4
        with:
          path: |
            deps
            _build
          key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('mix.lock') }}
          restore-keys: |
            mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-

      - run: mix deps.get
      - run: mix format --check-formatted
      - run: mix compile --warnings-as-errors
      - run: mix ecto.create && mix ecto.migrate
      - run: mix test

Qué hacen las partes menos evidentes

  • erlef/setup-beam@v1 instala Erlang/OTP y Elixir. Fije ambas versiones como cadenas entre comillas para que YAML no las convierta en números. La acción devuelve las versiones exactas que instaló, que la clave de caché utiliza mediante id: beam.
  • Clave de caché con las versiones de OTP y Elixir. El resultado compilado de _build solo es válido para las versiones que lo generaron. Incluirlas evita cargar archivos beam de una versión distinta. Los cambios en mix.lock generan una caché nueva, y restore-keys recurre a la más reciente para las mismas versiones.
  • deps y _build juntos. deps contiene los paquetes descargados, _build contiene el resultado compilado, incluidas las dependencias. Guardar ambos en caché es lo que acelera las ejecuciones posteriores. Compilar las dependencias es la parte más lenta de una ejecución en frío. Consulte cómo acelerar Elixir en GitHub Actions.
  • MIX_ENV: test a nivel de job hace que todos los pasos usen el entorno de prueba, de modo que _build/test es el directorio que se guarda en caché y se compila.
  • DATABASE_URL asume que config/runtime.exs o config/test.exs la leen. Los generadores de Phoenix usan URLs ecto://. Si su configuración de prueba fija el host de la base de datos, establézcalo en localhost y con el usuario y la contraseña indicados arriba.
  • --warnings-as-errors hace que la compilación falle ante advertencias del compilador, manteniendo limpio el código base.
  • Comprobación de estado del servicio. Sin ella, ecto.create podría ejecutarse antes de que Postgres acepte conexiones.

Variantes

Matriz de versiones

Añada pares en matrix.include, como otp: "26", elixir: "1.17" y otp: "27", elixir: "1.18". Combine versiones compatibles. Consulte compilaciones con matriz.

Análisis estático

Añada mix credo --strict y Dialyzer con dialyxir. Guarde en caché el directorio de la PLT (priv/plts) por separado, con clave en mix.lock, porque construirlo tarda muchos minutos.

Recursos

Las aplicaciones Phoenix con esbuild y Tailwind necesitan mix assets.setup y mix assets.build antes de las pruebas que renderizan páginas.

Particiones de pruebas

Mix admite MIX_TEST_PARTITION con --partitions. Combínelo con sharding de pruebas, usando una base de datos separada por partición.

Job de despliegue

Añada un segundo job solo en main que compile una release con mix release, la suba como artefacto y la despliegue con OIDC.

Ejecútelo en máquinas más rápidas

La BEAM ejecuta las pruebas de forma concurrente, por lo que los núcleos adicionales ayudan. Cambie una línea:

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

El job se ejecuta en una máquina nueva de 8 vCPU de compiler.dev, con alternativa automática. En el benchmark de compiler.dev, una aplicación Phoenix LiveView con Postgres pasó de 2m07s a 1m03s; consulte benchmarks. Los precios están en precios.

Preguntas frecuentes

¿Por qué guardar _build en caché además de deps?

Compilar las dependencias es lento, y _build conserva los resultados compilados.

¿Puedo omitir la versión de OTP en la clave de caché?

Es arriesgado. Los archivos beam compilados con una versión de OTP pueden no cargarse con otra.

¿Cómo encuentro versiones compatibles de OTP y Elixir?

La tabla de compatibilidad de Elixir en su documentación oficial enumera las versiones de OTP admitidas para cada release.

¿Causa problemas ecto.create si la base de datos ya existe?

No. Informa de que la base de datos ya existe y continúa.