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. Puedes extender tu flujo de trabajo de CI para almacenar en caché los archivos y cargar artefactos desde una ejecución de flujo de trabajo.
Los ejecutores hospedados en GitHub tienen una caché de herramientas con software preinstalado que incluye kits de desarrollo de Java (JDK) y Gradle. Para obtener una lista del software y las versiones preinstaladas para JDK y Gradle, consulta "Acerca de 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:
- "Sintaxis del flujo de trabajo para Acciones de GitHub"
- "Más información sobre las Acciones de GitHub"
Te recomendamos que tengas una comprensión básica de Java y del marco de Gradle. Para obtener más información, consulre "Introducción" en la documentación 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».
Utilizar el flujo de trabajo inicial de Gradle
GitHub Proporciona un flujo de trabajo inicial de Gradle que funciona con la mayoría de los proyectos de Java basados en Gradle. Para obtener más información, consulte el flujo de trabajo de inicio de Gradle.
Para comenzar rápidamente, puedes elegir el flujo de trabajo inicial de Gradle preconfigurado cuando crees un flujo de trabajo nuevo. Para obtener más información, consulta el "Guía de inicio rápido para GitHub Actions".
También puede agregar este flujo de trabajo manualmente si crea un archivo en el directorio .github/workflows
del repositorio.
# Este flujo de trabajo usa acciones que no GitHub no certifica.
# Estas las proporcionan entidades terceras y las gobiernan
# condiciones de servicio, políticas de privacidad y documentación de soporte
# en línea.
# GitHub recomienda anclar acciones a un SHA de confirmación.
# Para obtener una versión más reciente, debes actualizar el SHA.
# También puedes hacer referencia a una etiqueta o rama, pero la acción puede cambiar sin ninguna advertencia.
name: Java CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@ccb4328a959376b642e027874838f60f8e596de3
- name: Build with Gradle
uses: gradle/gradle-build-action@749f47bda3e44aa060e82d7b3ef7e40d953bd629
with:
arguments: build
Este flujo de trabajo realiza los siguientes pasos:
- El paso
checkout
descarga una copia del repositorio en el ejecutor. - El paso
setup-java
configura el JDK Eclipse Temurin (Java) 17 de Eclipse Adoptium. - El paso de "Validar el wrapper de Gradle" valida la sumas de verificaciones de los archivos JAR del wrapper de Gradle que estén presentes en el árbol fuente.
- El paso "Build with Gradle" realiza una compilación mediante la acción
gradle/gradle-build-action
proporcionada por la organización de Gradle en GitHub. La acción se encarga de invocar a Gradle, recolectar los resultados y almacenar el estado en el caché entre los jobs. Para obtener más información, veagradle/gradle-build-action
.
Los flujos de trabajo iniciales predeterminados son un punto de partida excelente para crear tu flujo de trabajo de prueba y de compilación y puedes personalizarlos de acuerdo con las necesidades de tu proyecto.
Ejecución en un sistema operativo diferente
El flujo de trabajo de inicio configura trabajos para que se ejecuten en Linux, mediante los ejecutores ubuntu-latest
hospedados en GitHub. Puede cambiar la clave runs-on
para ejecutar los trabajos en otro sistema operativo. Por ejemplo, puedes utilizar los ejecutores de Windows hospedados en GitHub.
runs-on: windows-latest
O puedes utilizar los ejecutores de macOS hospedados en GitHub.
runs-on: macos-latest
También puedes ejecutar jobs en contenedores de Docker, o puedes proporcionar un ejecutor auto-hospedado que se ejecute en tu propia infraestructura. Para obtener más información, vea «Sintaxis del flujo de trabajo para Acciones de GitHub».
Especificar la versión y la arquitectura de JVM
El flujo de trabajo de inicio configura PATH
para 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'``'adopt'
y x64
.
steps:
- uses: actions/checkout@v3
- name: Set up JDK 11 for x64
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'adopt'
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.
El flujo de trabajo de inicio 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@v3
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@ccb4328a959376b642e027874838f60f8e596de3
- name: Run the Gradle package task
uses: gradle/gradle-build-action@749f47bda3e44aa060e82d7b3ef7e40d953bd629
with:
arguments: -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, el gradle/gradle-build-action
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/gradle-build-action
. Para más información, vea gradle/gradle-build-action
.
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 «Almacenar los datos de los flujos de trabajo como artefactos».
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@v3
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@ccb4328a959376b642e027874838f60f8e596de3
- name: Build with Gradle
uses: gradle/gradle-build-action@749f47bda3e44aa060e82d7b3ef7e40d953bd629
with:
arguments: build
- uses: actions/upload-artifact@v3
with:
name: Package
path: build/libs