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 utilizando la herramienta de gestión de proyectos de software Maven. 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 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 Maven. A fin de obtener una lista de software y las versiones preinstaladas para JDK y Maven, vea "Especificaciones de 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 Maven. Para más información, vea la Guía de introducción a Maven en la documentación de Maven.
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 más información, vea "Configuración de la caché de herramientas en ejecutores autohospedados sin acceso a Internet".
Utilizar el flujo de trabajo inicial de Maven
GitHub proporciona un flujo de trabajo inicial de Maven que funcionará para la mayoría de los proyectos Java basados en Maven. Para más información, vea el flujo de trabajo de inicio de Maven.
Para iniciar rápidamente, puedes elegir el flujo de trabajo inicial de Maven preconfigurado cuando crees un flujo de trabajo nuevo. Para más información, vea el "Inicio rápido de GitHub Actions".
También puede agregar este flujo de trabajo manualmente si crea un archivo en el directorio .github/workflows
del repositorio.
name: Java CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- name: Build with Maven
run: mvn --batch-mode --update-snapshots package
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 de Java� 11 mediante Adoptium. - El paso "Compilar con Maven" ejecuta el destino
package
de Maven en modo no interactivo para garantizar que el código se compile, se superen las pruebas y se pueda crear un paquete.
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 más información, vea "Sintaxis de flujo de trabajo para GitHub Actions".
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@v2
- name: Set up JDK 11 for x64
uses: actions/setup-java@v2
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á el destino package
de forma predeterminada. En la configuración predeterminada de Maven, este comando descargará dependencias, construirá clases, ejecutar pruebas y las clases de paquetes en su formato distribuible, por ejemplo, un archivo JAR.
Si usas diferentes comandos para compilar tu proyecto, o si quieres usar un destino diferente, puedes especificarlos. Por ejemplo, es posible que quiera ejecutar el destino verify
configurado en un archivo pom-ci.xml.
steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- name: Run the Maven verify phase
run: mvn --batch-mode --update-snapshots verify
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 más información, vea "Conservación de datos de flujo de trabajo mediante artefactos".
Maven normalmente creará archivos de salida como JAR, EAR o WAR en el directorio target
. Para cargarlos como artefactos, puedes copiarlos en un nuevo directorio que contenga artefactos para cargar. Por ejemplo, puede crear un directorio denominado staging
. Después, puede cargar el contenido de ese directorio mediante la acción upload-artifact
.
steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- run: mvn --batch-mode --update-snapshots verify
- run: mkdir staging && cp target/*.jar staging
- uses: actions/upload-artifact@v2
with:
name: Package
path: staging