Saltar al contenido

Plantilla de flujo de trabajo de Maven para GitHub Actions

Última actualización

Este es un .github/workflows/ci.yml funcional para un proyecto Maven. Instala Java 21 con la caché de dependencias de Maven activada, compila y ejecuta las pruebas unitarias y de integración con mvn verify, y conserva los informes de pruebas en caso de fallo.

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:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        java: [17, 21]
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: ${{ matrix.java }}
          cache: maven

      - run: mvn --batch-mode --no-transfer-progress verify

      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: surefire-reports-${{ matrix.java }}
          path: "**/target/surefire-reports/"

Qué hacen las partes menos evidentes

  • cache: maven en setup-java almacena en caché ~/.m2/repository, con una clave basada en el hash de todos los archivos pom.xml. No se necesita un paso de caché independiente. Cuando cambia un pom.xml, se guarda una nueva caché.
  • --batch-mode elimina las solicitudes interactivas y los códigos de color. --no-transfer-progress oculta las líneas de progreso de descarga, que de otro modo llenarían el registro con miles de líneas.
  • verify ejecuta todo hasta las pruebas de integración (test, package, integration-test). Use mvn test para una verificación más rápida solo con pruebas unitarias en las pull requests.
  • Matriz con Java 17 y 21. Pruebe las versiones que admite. Si solo distribuye una versión, elimine la matriz para reducir a la mitad los minutos. Consulte compilaciones con matriz.
  • El nombre del artefacto incluye el valor de la matriz. Desde upload-artifact v4, los nombres deben ser únicos dentro de una ejecución. Consulte artefactos.
  • Wrapper. Si su repositorio tiene mvnw, ejecute ./mvnw para fijar la versión de Maven.

Variantes

Compilación paralela de módulos

Añada -T 1C para compilar módulos en paralelo, un hilo por núcleo. Esto solo funciona si los módulos y plugins son seguros para subprocesos.

Pruebas de integración con Testcontainers

Docker está disponible en ubuntu-latest, por lo que Testcontainers se ejecuta sin configuración adicional. La primera descarga de imágenes es la parte lenta; consulte caché de capas de Docker.

Contenedor de servicio de base de datos

Use un bloque services: con Postgres, como en la plantilla de Django, y pase la URL como variable de entorno.

Trabajo de despliegue o publicación

Añada un segundo trabajo con needs: build solo en main. Para las versiones, use setup-java con server-id y server-password para que Maven pueda leer las credenciales de los secretos.

macOS o Windows

Añada un eje os solo si la biblioteca debe funcionar en ellos.

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

Maven puede usar -T y muchos núcleos para las pruebas. Cambie una línea:

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

El trabajo se ejecuta en una máquina nueva de 8 vCPU de compiler.dev, con retorno automático a su runner original. El benchmark de compiler.dev de una aplicación Spring Boot (Maven) con Kafka, Postgres y Testcontainers pasó de 1m54s a 1m12s; consulte benchmarks. La lista de optimizaciones está en acelerar Maven en GitHub Actions, y los precios en precios.

Preguntas frecuentes

¿Necesito actions/cache para Maven?

No. setup-java con cache: maven hace el trabajo.

¿Por qué la caché no se restaura después de editar un pom.xml?

La clave incluye cada pom.xml, por lo que un cambio crea una entrada nueva. No se usa la caché anterior, aunque Maven puede volver a descargar solo lo que cambió.

¿Puedo almacenar en caché la salida de compilación de Maven?

Maven no tiene una caché de tareas integrada. Una caché de compilación remota requiere la Maven Build Cache Extension.

¿Cómo compilo solo los módulos modificados?

Use -pl con -amd y un paso con los archivos modificados, o cambie a una herramienta de compilación con caché de tareas.