Nota: Actualmente los ejecutores hospedados en GitHub no se admiten en GitHub Enterprise Server. Puede ver más información sobre la compatibilidad futura planeada en GitHub public roadmap.
Introducción
Esta guía te muestra cómo crear un flujo de trabajo que realiza la integración continua (CI) para tu proyecto Java usando el sistema de construcción Gradle. El flujo de trabajo que creas te permitirá ver cuándo las confirmaciones de una solicitud de extracción causan la construcción o las fallas de prueba en tu rama por defecto; este enfoque puede ayudar a garantizar que tu código siempre sea correcto. Puede ampliar su flujo de trabajo de CI para copiar archivos en caché y cargar artefactos desde una ejecución de flujo de trabajo.
Los ejecutores hospedados en GitHub tienen un caché de herramientas con software pre-instalado, lo cual incluye los Kits de Desarrollo de Java (JDKs) y Gradle. Para obtener una lista del software y las versiones preinstaladas para JDK y Gradle, consulta "Utilizar los ejecutores hospedados en GitHub".
Requisitos previos
Deberías estar familiarizado con YAML y la sintaxis para las GitHub Actions. Para más información, consulte:
Te recomendamos que tengas una comprensión básica de Java y del marco de Gradle. Para obtener más información, consulta el Manual de usuario de Gradle.
Utilizar ejecutores auto-hospedados en GitHub Enterprise Server
Cuando use acciones de configuración, (como actions/setup-LANGUAGE
) en GitHub Enterprise Server con ejecutores autohospedados, es posible que necesite configurar la caché de herramientas en los ejecutores que no tienen acceso a Internet. Para obtener más información, vea «Configurar el caché de la herramienta en ejecutores auto-hospedados sin acceso a internet».
Uso de una plantilla de flujo de trabajo de Gradle
Para comenzar rápidamente, agregue una plantilla de flujo de trabajo al directorio .github/workflows
del repositorio.
GitHub proporciona una plantilla de flujo de trabajo para Gradle que debería funcionar con la mayoría de los proyectos de Java basados en Gradle. En las secciones siguientes de esta guía se proporcionan ejemplos de cómo puede personalizar esta plantilla de flujo de trabajo.
-
En GitHub, navegue hasta la página principal del repositorio.
-
En el nombre del repositorio, haz clic en Acciones.
-
Si ya tiene un flujo de trabajo en su repositorio, haga clic en New workflow (Nuevo flujo de trabajo).
-
En la página "Elegir un flujo de trabajo" se muestra una selección de plantillas de flujo de trabajo recomendadas. Busca «Java con Gradle».
-
En el flujo de trabajo «Java con Gradle», haz clic en Configurar.
Si no encuentra la plantilla de flujo de trabajo "Java con Gradle", copie el siguiente código de flujo de trabajo en un nuevo archivo llamado
gradle.yml
en el directorio.github/workflows
del repositorio.YAML name: Java CI with Gradle on: push: branches: [ "main" ] pull_request: branches: [ "main" ] permissions: contents: read jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up JDK 17 uses: actions/setup-java@v4 with: java-version: '17' distribution: 'temurin' - name: Setup Gradle uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0 - name: Build with Gradle run: ./gradlew build
name: Java CI with Gradle on: push: branches: [ "main" ] pull_request: branches: [ "main" ] permissions: contents: read jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up JDK 17 uses: actions/setup-java@v4 with: java-version: '17' distribution: 'temurin' - name: Setup Gradle uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0 - name: Build with Gradle run: ./gradlew build
Este flujo de trabajo realiza los siguientes pasos:
-
Revisa una copia del repositorio del proyecto.
-
Configura el JDK de Java.
-
Configura el entorno de Gradle. La acción
gradle/actions/setup-gradle
se encarga del estado de almacenamiento en caché entre ejecuciones de flujo de trabajo y proporciona un resumen detallado de todas las ejecuciones de Gradle. -
El paso "Compilar con Gradle" ejecuta la tarea
build
mediante el encapsulador de Gradle. -
Edita el flujo de trabajo según sea necesario. Por ejemplo, cambia la versión de Java.
Notas:
- Esta la plantilla de flujo de trabajo contiene una acción que no está certificada por GitHub. Las acciones que proporciona un tercero se rigen por términos de servicio, directivas de privacidad y documentación externos.
- Si usas acciones de terceros, debes usar una versión especificada por un SHA de confirmación. Si se revisa la acción y deseas usar la versión más reciente, deberás actualizar el SHA. También puedes especificar a una etiqueta o rama, pero la acción puede cambiar sin ninguna advertencia. Para obtener más información, vea «Fortalecimiento de seguridad para GitHub Actions».
-
Haga clic en Commit changes (Confirmar cambios).
Especificar la versión y la arquitectura de Java
La plantilla de flujo de trabajo configura PATH
a fin de que contenga OpenJDK 8 para la plataforma x64. Si quieres usar una versión diferente de Java o tener como destino una arquitectura diferente (x64
o x86
), puedes usar la acción setup-java
para elegir un entorno de ejecución de Java diferente.
Por ejemplo, para usar la versión 11 del JDK proporcionado por Adoptium para la plataforma x64, puedes usar la acción setup-java
y configurar los parámetros java-version
, distribution
y architecture
en '11'``'temurin'
y x64
.
steps: - uses: actions/checkout@v4 - name: Set up JDK 11 for x64 uses: actions/setup-java@v4 with: java-version: '11' distribution: 'temurin' architecture: x64
steps:
- uses: actions/checkout@v4
- name: Set up JDK 11 for x64
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
architecture: x64
Para obtener más información, consulta la acción setup-java
.
Construir y probar tu código
Puedes usar los mismos comandos que usas de forma local para construir y probar tu código.
La plantilla de flujo de trabajo ejecutará la tarea build
de manera predeterminada. En la configuración de Gradle predeterminada, este comando descargará las dependencias, construirá clases, ejecutará pruebas y empaquetará las clases en su formato distribuible, por ejemplo, un archivo JAR.
Si usas diferentes comandos para construir tu proyecto, o si quieres usar una tarea diferente, puedes especificarlo. Por ejemplo, puede que quiera ejecutar la tarea package
configurada en el archivo ci.gradle.
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 with: java-version: '17' distribution: 'temurin' - name: Setup Gradle uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0 - name: Build with Gradle run: ./gradlew -b ci.gradle package
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
- name: Build with Gradle
run: ./gradlew -b ci.gradle package
Almacenar dependencias en caché
Las dependencias de compilación se pueden almacenar en caché para acelerar las ejecuciones de flujo de trabajo. Cuando se ejecuta correctamente, gradle/actions/setup-gradle
almacena en caché las partes importantes del directorio principal del usuario de Gradle. En los jobs futuros, el caché se restablecerá para que los scripts de compilación no necesiten recompilarse y las dependencias no necesiten descargarse desde los repositorios de paquetes remotos.
El almacenamiento en caché está habilitado de manera predeterminada cuando se usa la acción gradle/actions/setup-gradle
. Para obtener más información, vea gradle/actions/setup-gradle
.
Empaquetar datos de flujo de trabajo como artefactos
Una vez que tu compilación haya tenido éxito y tus pruebas hayan pasado, es posible que desees cargar los paquetes Java resultantes como un artefacto de construcción. Esto almacenará los paquetes compilados como parte de la ejecución del flujo de trabajo y te permitirá descargarlos. Los artefactos pueden ayudarte a probar y depurar solicitudes de extracción en tu entorno local antes de que se fusionen. Para obtener más información, vea «Almacenamiento y uso compartido de datos desde un flujo de trabajo».
Normalmente, Gradle creará archivos de salida como JAR, EAR o WAR en el directorio build/libs
. Puede cargar el contenido de ese directorio mediante la acción upload-artifact
.
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 with: java-version: '17' distribution: 'temurin' - name: Setup Gradle uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0 - name: Build with Gradle run: ./gradlew build - name: Upload build artifacts uses: actions/upload-artifact@v3 with: name: Package path: build/libs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
- name: Build with Gradle
run: ./gradlew build
- name: Upload build artifacts
uses: actions/upload-artifact@v3
with:
name: Package
path: build/libs