Construir y probar Java con Maven

En este artículo

Puedes crear un flujo de trabajo de integración continua (CI) en acciones de GitHub para construir y probar tu proyecto Java con Maven.

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 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 Maven. Para obtener una lista del software y las versiones preinstaladas para JDK y Maven, consulta "Using GitHub-hosted runners".

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 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 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.

YAML
name: Java CI

El nombre del flujo de trabajo. GitHub muestra los nombres de los flujos de trabajo en la pestaña "Acciones" del repositorio. Si omite name, GitHub muestra la ruta de acceso del archivo de flujo de trabajo relativa a la raíz del repositorio.

on: [push]
jobs:
  build:
    runs-on: ubuntu-latest

Puede ejecutar este flujo de trabajo mediante otros sistemas operativos.

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, puede utilizar los ejecutores de Windows hospedados en GitHub si especifica runs-on: windows-latest. O puede ejecutar los ejecutores de macOS hospedados en GitHub si utiliza 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».

    steps:
      - uses: actions/checkout@v4

Este paso utiliza la acción actions/checkout para descargar una copia del repositorio en el ejecutor.

      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

Este paso utiliza la acción actions/setup-java para configurar el JDK Eclipse Temurin (Java) 17 de Eclipse Adoptium.

      - name: Build with Maven
        run: mvn --batch-mode --update-snapshots package

The "Build with Maven" step runs the Maven package target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created.

# El nombre del flujo de trabajo. GitHub muestra los nombres de los flujos de trabajo en la pestaña "Acciones" del repositorio. Si omite `name`, GitHub muestra la ruta de acceso del archivo de flujo de trabajo relativa a la raíz del repositorio.
name: Java CI

#
on: [push]
#
jobs:
  build:

    # <!-- This is a YAML comment for use in annotated code examples. -->
    # Puede ejecutar este flujo de trabajo mediante otros sistemas operativos.
    #
    # 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, puede utilizar los ejecutores de Windows hospedados en GitHub si especifica `runs-on: windows-latest`. O puede ejecutar los ejecutores de macOS hospedados en GitHub si utiliza `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 «[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on)».
    runs-on: ubuntu-latest
#
    steps:
      # Este paso utiliza la acción `actions/checkout` para descargar una copia del repositorio en el ejecutor.
      - uses: actions/checkout@v4
      # Este paso utiliza la acción `actions/setup-java` para configurar el JDK Eclipse Temurin (Java) 17 de Eclipse Adoptium.
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'
      # The "Build with Maven" step runs the Maven `package` target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created.
      - name: Build with Maven
        run: mvn --batch-mode --update-snapshots package

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.

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'``'temurin' y x64.

YAML
steps:
  - uses: actions/checkout@v4
  - name: Set up JDK 11 for x64
    uses: actions/setup-java@v3
    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.

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.

YAML
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-java@v3
    with:
      java-version: '17'
      distribution: 'temurin'
  - name: Run the Maven verify phase
    run: mvn --batch-mode --update-snapshots verify

Almacenar dependencias en caché

Puedes almacenar en caché tus dependencias para acelerar tus ejecuciones de flujo de trabajo. Después de una ejecución correcta, el repositorio de Maven local se almacenará en una memoria caché. En las ejecuciones de flujo de trabajo futuras, el caché se restaurará para que las dependencias no necesiten descargarse desde los repositorios remotos de Maven. Puede almacenar en caché las dependencias simplemente mediante la acción setup-java, o bien puede usar la acción cache para la configuración personalizada y más avanzada.

YAML
steps:
  - uses: actions/checkout@v4
  - name: Set up JDK 11
    uses: actions/setup-java@v3
    with:
      java-version: '17'
      distribution: 'temurin'
      cache: maven
  - name: Build with Maven
    run: mvn --batch-mode --update-snapshots verify

Este flujo de trabajo guardará los contenidos del repositorio local de Maven, ubicado en el directorio .m2 del directorio principal del ejecutor. La clave de caché será el contenido con hash de pom.xml, por lo que los cambios en pom.xml invalidarán la caché.

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».

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.

YAML
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-java@v3
    with:
      java-version: '17'
      distribution: 'temurin'
  - run: mvn --batch-mode --update-snapshots verify
  - run: mkdir staging && cp target/*.jar staging
  - uses: actions/upload-artifact@v3
    with:
      name: Package
      path: staging