Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para Laravel

Última actualización

Este es un .github/workflows/ci.yml funcional para una aplicación Laravel probada con MySQL. Instala PHP con setup-php, guarda en caché las descargas de Composer, crea el .env, ejecuta las migraciones de la base de datos y lanza Pint y el conjunto de 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:
      mysql:
        image: mysql:8.0
        env:
          MYSQL_ROOT_PASSWORD: root
          MYSQL_DATABASE: laravel_test
        ports:
          - 3306:3306
        options: >-
          --health-cmd "mysqladmin ping -h 127.0.0.1 -proot"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 20
    env:
      APP_ENV: testing
      DB_CONNECTION: mysql
      DB_HOST: 127.0.0.1
      DB_PORT: 3306
      DB_DATABASE: laravel_test
      DB_USERNAME: root
      DB_PASSWORD: root
    steps:
      - uses: actions/checkout@v4

      - uses: shivammathur/setup-php@v2
        with:
          php-version: "8.3"
          extensions: mbstring, pdo_mysql, bcmath
          coverage: none

      - name: Get Composer cache directory
        id: composer-cache
        run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT"

      - uses: actions/cache@v4
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: composer-${{ runner.os }}-${{ hashFiles('composer.lock') }}
          restore-keys: |
            composer-${{ runner.os }}-

      - run: composer install --no-interaction --prefer-dist --no-progress
      - run: cp .env.example .env
      - run: php artisan key:generate
      - run: vendor/bin/pint --test
      - run: php artisan migrate --force
      - run: php artisan test --parallel

Qué hacen las partes menos evidentes

  • shivammathur/setup-php@v2 instala la versión de PHP y las extensiones que indique. coverage: none desactiva Xdebug y PCOV, lo que acelera las pruebas; use coverage: pcov solo cuando recopile cobertura.
  • Los pasos de caché de Composer guardan la caché de descargas de Composer, no vendor/. El directorio se obtiene de Composer mismo, así que la ruta es correcta en cualquier runner. La clave es el hash de composer.lock.
  • La comprobación de estado de MySQL usa 127.0.0.1 y la contraseña de root. MySQL tarda varios segundos en inicializarse, por lo que el número alto de reintentos evita errores de conexión prematuros.
  • DB_HOST: 127.0.0.1 es intencionado. Con localhost, el controlador MySQL de PHP intenta usar un socket Unix que no existe y falla.
  • cp .env.example .env y key:generate dotan a la aplicación de un entorno válido y de una APP_KEY sin secretos reales.
  • pint --test informa de problemas de estilo sin reescribir archivos, de modo que el CI falla en lugar de corregirlos en silencio.
  • artisan test --parallel necesita el paquete brianium/paratest y crea una base de datos por proceso. Elimine el indicador si no lo usa.

Variantes

Matriz de versiones de PHP

Añada matrix.php: ["8.2", "8.3", "8.4"] y use ${{ matrix.php }}. Mantenga las versiones entre comillas. Consulte compilaciones con matriz.

Recursos del frontend

Añada actions/setup-node@v4 con cache: npm, y luego npm ci y npm run build antes de las pruebas si las pruebas de funcionalidades renderizan recursos de Vite.

Postgres o SQLite

Cambie el servicio por postgres:16 con pg_isready y establezca DB_CONNECTION: pgsql. SQLite en memoria no necesita servicio y es más rápido, pero oculta las diferencias entre motores.

Job de despliegue

Añada un segundo job con needs: test solo en main, y use OIDC para el acceso a la nube.

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

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 reversión automática a su runner original. Las pruebas en paralelo aprovechan bien los núcleos adicionales. Consulte cómo acelerar Laravel en GitHub Actions y precios.

Preguntas frecuentes

¿Debo guardar en caché el directorio vendor?

Guarde en caché la caché de descargas de Composer. composer install desde una caché caliente es rápido y siempre coherente con composer.lock.

¿Por qué MySQL rechaza conexiones al inicio?

Sigue arrancando. Mantenga la comprobación de estado y use 127.0.0.1.

¿Cómo ejecuto las pruebas de navegador con Dusk?

Dusk necesita Chrome y un servidor de aplicación en ejecución. Ejecútelo en un job separado para que las pruebas de navegador lentas no retrasen las pruebas unitarias, y suba las capturas de pantalla como artifact.

¿Puedo usar Sail en CI?

Sí, pero añade el tiempo de arranque de Docker. Usar setup-php con contenedores de servicio suele ser más rápido.