Construir y probar Java con Ant

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

Introducción

Esta guía te muestra cómo crear un flujo de trabajo que realiza integración continua (CI) para tu proyecto de Java por medio del sistema de construcción Ant. 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 ampliar tu flujo de trabajo de CI para cargar artefactos desde una ejecución de flujo de trabajo.

Los ejecutores alojados en GitHub tienen una memoria caché de herramientas con software preinstalado, que incluye kits de desarrollo de Java (JDK) y Ant. Para obtener una lista del software y las versiones preinstaladas para JDK y Ant, 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:

Recomendamos que tengas un conocimiento básico de Java y de la estructura de Ant. Para obtener más información, vea el Manual de Apache Ant.

Utilizar el flujo de trabajo inicial de Ant

GitHub proporciona un flujo de trabajo inicial de Ant que funcionará para la mayoría de los proyectos de Java basados en Ant. Para obtener más información, vea el flujo de trabajo de inicio de Ant. 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.

Para comenzar rápidamente, puedes elegir el flujo de trabajo inicial de Ant preconfigurado cuando crees un nuevo flujo de trabajo. 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 Ant
        run: ant -noinput -buildfile build.xml

This step runs the default target in your build.xml file in non-interactive mode.

# 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'
      # This step runs the default target in your `build.xml` file in non-interactive mode.
      - name: Build with Ant
        run: ant -noinput -buildfile build.xml

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 predeterminado especificado en el archivo build.xml. Normalmente, tu objetivo predeterminado se configurará para crear clases, ejecutar pruebas y empaquetar clases en su formato distribuible, por ejemplo, un archivo JAR.

Si usas diferentes comandos para construir tu proyecto, o si deseas ejecutar un objetivo diferente, puedes especificarlos. Por ejemplo, puede que quiera ejecutar el destino jar configurado en el archivo _build-ci.xml_.

YAML
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-java@v3
    with:
      java-version: '17'
      distribution: 'temurin'
  - name: Run the Ant jar target
    run: ant -noinput -buildfile build-ci.xml jar

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

Ant normalmente creará archivos de salida como JAR, EAR o WAR en el directorio build/jar. 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: ant -noinput -buildfile build.xml
  - uses: actions/upload-artifact@v3
    with:
      name: Package
      path: build/jar