Esta versão do GitHub Enterprise Server foi descontinuada em 2023-09-25. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Criar e testar o Java com o Ant

Neste artigo

Você pode criar um fluxo de trabalho de integração contínua (CI) no GitHub Actions para criar e testar o seu projeto Java com o Ant.

Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Introdução

Este guia mostra como criar um fluxo de trabalho que realiza a integração contínua (CI) para o seu projeto Java usando o sistema de criação do Ant. O fluxo de trabalho que você criar permitirá que você veja quando commits em um pull request gerarão falhas de criação ou de teste em comparação com o seu branch-padrão. Essa abordagem pode ajudar a garantir que seu código seja sempre saudável. Você pode estender seu fluxo de trabalho de CI para enviar artefatos a partir da execução de um fluxo de trabalho.

Os executores hospedados no GitHub têm um cache de ferramentas com programas de software pré-instalado, que incluem os JDKs (Java Development Kits) e o Ant. Para obter uma lista de software e as versões pré-instaladas para JDK e Ant, confira "Using GitHub-hosted runners".

Pré-requisitos

Você deve estar familiarizado com o YAML e a sintaxe do GitHub Actions. Para obter mais informações, consulte:

Recomendamos que você tenha um entendimento básico da estrutura do Java e do Ant. Para obter mais informações, confira o Manual do Apache Ant.

Usar executores auto-hospedados no GitHub Enterprise Server

Ao usar ações de instalação (como actions/setup-LANGUAGE) no GitHub Enterprise Server com executores auto-hospedados, talvez seja necessário configurar o cache de ferramentas nos executores que não têm acesso à Internet. Para obter mais informações, confira "Configurar o cache de ferramentas em executores auto-hospedados sem acesso à internet".

Usando o fluxo de trabalho inicial do Ant

GitHub fornece um fluxo de trabalho inicial do Ant que funcionará para a maioria dos projetos Java baseados no Ant. Para obter mais informações, confira o fluxo de trabalho inicial do Ant. Os fluxos de trabalho inicial padrão são excelentes pontos de partida ao criar seu fluxo de trabalho de criação e teste, e você pode personalizar o fluxo de trabalho inicial para atender às necessidades do seu projeto.

Para iniciar rapidamente, você pode escolher o fluxo de trabalho inicial pré-configurado ao criar um novo fluxo de trabalho. Para obter mais informações, confira "Início rápido para GitHub Actions".

Adicione também esse fluxo de trabalho manualmente criando um arquivo no diretório .github/workflows do repositório.

YAML
name: Java CI

Nome do fluxo de trabalho. O GitHub exibe os nomes dos fluxos de trabalho na guia "Ações" do repositório. Se você omitir name, o GitHub exibirá o caminho do arquivo de fluxo de trabalho em relação à raiz do repositório.

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

Você pode executar esse fluxo de trabalho usando um sistema operacional diferente.

O fluxo de trabalho inicial configura os trabalhos a serem executados no Linux usando os executores ubuntu-latest hospedados no GitHub. É possível alterar a chave runs-on para executar seus trabalhos em outro sistema operacional.

Por exemplo, você pode usar os executores Windows hospedados no GitHub especificando runs-on: windows-latest. Ou você pode executar os executores macOS hospedados no GitHub usando runs-on: macos-latest.

Você também pode executar tarefas em contêineres Docker ou fornecer um executor de auto-hospedagem que funciona na sua própria infraestrutura. Para obter mais informações, confira "Sintaxe de fluxo de trabalho para o GitHub Actions".

    steps:
      - uses: actions/checkout@v4

Esta etapa usa a ação actions/checkout para fazer download de uma cópia do repositório no executor.

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

Esta etapa usa a ação actions/setup-java para configurar o JDK do Eclipse Temurin (Java) 17 do 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.

# Nome do fluxo de trabalho. O GitHub exibe os nomes dos fluxos de trabalho na guia "Ações" do repositório. Se você omitir `name`, o GitHub exibirá o caminho do arquivo de fluxo de trabalho em relação à raiz do repositório.
name: Java CI

#
on: [push]
#
jobs:
  build:
    # <!-- This is a YAML comment for use in annotated code examples. -->
    # Você pode executar esse fluxo de trabalho usando um sistema operacional diferente.
    #
    # O fluxo de trabalho inicial configura os trabalhos a serem executados no Linux usando os executores `ubuntu-latest` hospedados no GitHub. É possível alterar a chave `runs-on` para executar seus trabalhos em outro sistema operacional.
    #
    # Por exemplo, você pode usar os executores Windows hospedados no GitHub especificando `runs-on: windows-latest`. Ou você pode executar os executores macOS hospedados no GitHub usando `runs-on: macos-latest`.
    #
    # Você também pode executar tarefas em contêineres Docker ou fornecer um executor de auto-hospedagem que funciona na sua própria infraestrutura. Para obter mais informações, confira "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on)".
    runs-on: ubuntu-latest
#
    steps:
      # Esta etapa usa a ação `actions/checkout` para fazer download de uma cópia do repositório no executor.
      - uses: actions/checkout@v4
      # Esta etapa usa a ação `actions/setup-java` para configurar o JDK do Eclipse Temurin (Java) 17 do 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

Especificando a versão e a arquitetura da JVM

O fluxo de trabalho inicial configura o PATH para conter OpenJDK 8 para a plataforma x64. Se você quiser usar uma versão diferente do Java, ou escolher uma arquitetura diferente (x64 ou x86), você pode usar a ação setup-java para escolher um ambiente de execução Java diferente.

Por exemplo, para usar a versão 11 do JDK fornecida pelo Adoptium para a plataforma x64, você poderá usar a ação setup-java e configurar os parâmetros java-version, distribution e architecture para '11', 'temurin' e 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 obter mais informações, confira a ação setup-java.

Criar e testar seu código

Você pode usar os mesmos comandos usados localmente para criar e testar seu código.

O fluxo de trabalho inicial executará o destino padrão especificado no arquivo debuild.xml. Seu alvo-padrão será comumente definido para criar classes, executar testes e classes de pacote em seu formato distribuível como, por exemplo, um arquivo JAR.

Se você usa comandos diferentes para criar seu projeto ou se você quer executar um alvo diferente, você poderá especificá-los. Por exemplo, o ideal é executar o destino jar configurado no arquivo _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

Empacotar dados do fluxo de trabalho como artefatos

Após a sua criação ter sido criada com sucesso e os seus testes aprovados, é possível que você deseje fazer o upload dos Java resultantes como um artefato de criação. Isso armazenará os pacotes criados como parte da execução do fluxo de trabalho e permitirá que você faça o download desses pacotes. Os artefatos podem ajudá-lo a testar e depurar os pull requests no seu ambiente local antes de serem mesclados. Para obter mais informações, confira "Armazenar dados do fluxo de trabalho como artefatos".

Em geral, o Ant criará arquivos de saída como JARs, EARs ou WARs no diretório build/jar. Você pode carregar o conteúdo desse diretório usando a ação 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