Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para Gradle

Última actualización

Este es un .github/workflows/ci.yml funcional para una compilación con Gradle, como un proyecto Spring Boot, Kotlin o una biblioteca Android. Usa gradle/actions/setup-gradle, que almacena en caché el estado de Gradle, y después ejecuta ./gradlew build.

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
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 21

      - uses: gradle/actions/setup-gradle@v4
        with:
          cache-read-only: ${{ github.ref != 'refs/heads/main' }}

      - run: ./gradlew build --no-daemon

      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: test-reports
          path: "**/build/reports/tests/"

Qué hacen las partes menos evidentes

  • setup-java instala el JDK. Temurin es una distribución gratuita muy utilizada. Use la versión de Java que requiere su proyecto.
  • gradle/actions/setup-gradle@v4 reemplaza a gradle/gradle-build-action. Almacena en caché el directorio de usuario de Gradle (dependencias descargadas, distribución del wrapper, entradas de la caché de compilación) y genera un resumen en el trabajo. No necesita cache: gradle en setup-java también; usar ambos solo duplica el trabajo.
  • cache-read-only hace que las ejecuciones de pull request restauren la caché pero no la guarden. Solo main escribe, lo que mantiene la caché limpia y evita muchas entradas casi idénticas. Consulte Caché de Gradle en CI.
  • ./gradlew ejecuta el wrapper, por lo que la versión de Gradle es la que fija el proyecto. Añada gradle/actions/wrapper-validation@v4 como primer paso si quiere verificar la suma de comprobación del jar del wrapper por seguridad de la cadena de suministro.
  • --no-daemon evita mantener un daemon activo en un entorno de una sola ejecución.
  • Artefacto de fallo. La subida con if: failure() conserva los informes de pruebas en HTML cuando las pruebas fallan. Consulte artefactos.
  • Tiempo límite de 30 minutos. Las compilaciones grandes con varios módulos pueden ser lentas; ajústelo cuando conozca su tiempo habitual.

Variantes

Matriz de varias versiones o sistemas operativos

Añada matrix.java: [17, 21] y configure java-version: ${{ matrix.java }}. Resulta útil para bibliotecas. Consulte compilaciones con matriz.

Caché de compilación de Gradle

Active org.gradle.caching=true en gradle.properties. Con setup-gradle, la caché de compilación local se guarda en el estado almacenado, de modo que las tareas sin cambios se omiten. Para una caché de compilación remota compartida, configure un servidor de caché remoto en settings.gradle.

Pruebas con base de datos

Use un bloque services: con Postgres, como en la plantilla de Django. Con Testcontainers no hace falta un bloque de servicios, porque Docker está disponible en el runner.

Android

Añada android-actions/setup-android@v3 y ejecute ./gradlew assembleDebug testDebugUnitTest lintDebug.

Job de despliegue

Añada un segundo trabajo con needs: build solo en main y use OIDC para las credenciales de la nube.

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

Gradle paraleliza entre núcleos y se beneficia de un disco rápido. 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 un respaldo en su runner original. En el benchmark de compiler.dev, una aplicación Angular y Spring Boot (Gradle) pasó de 6m57s a 2m18s; consulte benchmarks. La optimización completa está en acelerar Gradle en GitHub Actions, y los precios están en precios.

Preguntas frecuentes

¿Basta con setup-gradle o necesito actions/cache?

Basta. Se encarga de las claves de caché y de la limpieza.

¿Por qué la caché no se guarda en los pull requests?

Eso se debe a la opción cache-read-only. Elimínela si quiere que los pull requests también escriban en la caché.

¿Debo usar el daemon de Gradle en CI?

Normalmente no en compilaciones únicas. El wrapper inicia un daemon de todos modos, salvo que lo desactive.

¿Cómo acelero las pruebas?

Active maxParallelForks y reparta las pruebas entre trabajos. Consulte fragmentación de pruebas.