Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 5.25 KB

building-and-testing-java-with-ant.md

File metadata and controls

127 lines (95 loc) · 5.25 KB
title intro redirect_from versions type topics shortTitle
Building and testing Java with Ant
You can create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Ant.
/actions/language-and-framework-guides/building-and-testing-java-with-ant
/actions/guides/building-and-testing-java-with-ant
/actions/automating-builds-and-tests/building-and-testing-java-with-ant
fpt ghes ghec
*
*
*
tutorial
CI
Java
Ant
Build & test Java & Ant

{% data reusables.actions.enterprise-github-hosted-runners %}

Introduction

This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to upload artifacts from a workflow run.

{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Ant. For a list of software and the pre-installed versions for JDK and Ant, see AUTOTITLE.

Prerequisites

You should be familiar with YAML and the syntax for {% data variables.product.prodname_actions %}. For more information, see:

We recommend that you have a basic understanding of Java and the Ant framework. For more information, see the Apache Ant Manual.

{% data reusables.actions.enterprise-setup-prereq %}

Using an Ant workflow template

{% data reusables.actions.workflow-templates-get-started %}

{% data variables.product.prodname_dotcom %} provides a workflow template for Ant that should work for most Java with Ant projects. The subsequent sections of this guide give examples of how you can customize this workflow template.

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.actions.new-starter-workflow %}

  1. The "Choose a workflow" page shows a selection of recommended workflow templates. Search for "Java with Ant".
  2. On the "Java with Ant" workflow, click Configure.

{%- ifversion ghes %}

If you don't find the "Java with Ant" workflow template, copy the following workflow code to a new file called ant.yml in the .github/workflows directory of your repository.

name: Java CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: {% data reusables.actions.action-checkout %}
    - name: Set up JDK 11
      uses: {% data reusables.actions.action-setup-java %}
      with:
        java-version: '11'
        distribution: 'temurin'
    - name: Build with Ant
      run: ant -noinput -buildfile build.xml

{%- endif %}

  1. Edit the workflow as required. For example, change the Java version.
  2. Click Commit changes.

{% ifversion fpt or ghec %} The ant.yml workflow file is added to the .github/workflows directory of your repository. {% endif %}

{% data reusables.actions.java-jvm-architecture %}

Building and testing your code

You can use the same commands that you use locally to build and test your code.

The workflow template will run the default target specified in your build.xml file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.

If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the jar target that's configured in your build-ci.xml file.

steps:
  - uses: {% data reusables.actions.action-checkout %}
  - uses: {% data reusables.actions.action-setup-java %}
    with:
      java-version: '17'
      distribution: 'temurin'
  - name: Run the Ant jar target
    run: ant -noinput -buildfile build-ci.xml jar

Packaging workflow data as artifacts

After your build has succeeded and your tests have passed, you may want to upload the resulting Java packages as a build artifact. This will store the built packages as part of the workflow run, and allow you to download them. Artifacts can help you test and debug pull requests in your local environment before they're merged. For more information, see AUTOTITLE.

Ant will usually create output files like JARs, EARs, or WARs in the build/jar directory. You can upload the contents of that directory using the upload-artifact action.

steps:
  - uses: {% data reusables.actions.action-checkout %}
  - uses: {% data reusables.actions.action-setup-java %}
    with:
      java-version: '17'
      distribution: 'temurin'

  - run: ant -noinput -buildfile build.xml
  - uses: {% data reusables.actions.action-upload-artifact %}
    with:
      name: Package
      path: build/jar