GitHub - actions/setup-java: Set up your GitHub Actions workflow with a specific version of Java (original) (raw)

Setup Java

Basic validation Validate Java e2e Validate cache

The setup-java action provides the following functionality for GitHub Actions runners:

This action allows you to work with Java and Scala projects.

V2 vs V1

Usage

Maven options

The action has a bunch of inputs to generate maven's settings.xml on the fly and pass the values to Apache Maven GPG Plugin as well as Apache Maven Toolchains. See advanced usage for more.

Basic Configuration

Eclipse Temurin

steps:

Azul Zulu OpenJDK

steps:

Supported version syntax

The java-version input supports an exact version or a version range using SemVer notation:

Supported distributions

Currently, the following distributions are supported:

Keyword Distribution Official site License
temurin Eclipse Temurin Link Link
zulu Azul Zulu OpenJDK Link Link
adopt or adopt-hotspot AdoptOpenJDK Hotspot Link Link
adopt-openj9 AdoptOpenJDK OpenJ9 Link Link
liberica Liberica JDK Link Link
microsoft Microsoft Build of OpenJDK Link Link
corretto Amazon Corretto Build of OpenJDK Link Link
semeru IBM Semeru Runtime Open Edition Link Link
oracle Oracle JDK Link Link
dragonwell Alibaba Dragonwell JDK Link Link
sapmachine SAP SapMachine JDK/JRE Link Link
graalvm Oracle GraalVM Link Link
jetbrains JetBrains Runtime Link Link

NOTE: The different distributors can provide discrepant list of available versions / supported configurations. Please refer to the official documentation to see the list of supported versions.

NOTE: AdoptOpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from adopt and adopt-openj9, to temurin and semeru respectively, to keep receiving software and security updates. See more details in the Good-bye AdoptOpenJDK post.

NOTE: For Azul Zulu OpenJDK architectures x64 and arm64 are mapped to x86 / arm with proper hw_bitness.

NOTE: To comply with the GraalVM Free Terms and Conditions (GFTC) license, it is recommended to use GraalVM JDK 17 version 17.0.12, as this is the only version of GraalVM JDK 17 available under the GFTC license. Additionally, it is encouraged to consider upgrading to GraalVM JDK 21, which offers the latest features and improvements.

Caching packages dependencies

The action has a built-in functionality for caching and restoring dependencies. It uses toolkit/cache under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}, where the hash is based on the following files:

When the option cache-dependency-path is specified, the hash is based on the matching file. This option supports wildcards and a list of file names, and is especially useful for monorepos.

The workflow output cache-hit is set to indicate if an exact match was found for the key as actions/cache does.

The cache input is optional, and caching is turned off by default.

Caching gradle dependencies

steps:

Caching maven dependencies

steps:

Caching sbt dependencies

steps:

Cache segment restore timeout

Usually, cache gets downloaded in multiple segments of fixed sizes. Sometimes, a segment download gets stuck, which causes the workflow job to be stuck. The cache segment download timeout was introduced to solve this issue as it allows the segment download to get aborted and hence allows the job to proceed with a cache miss. The default value of the cache segment download timeout is set to 10 minutes and can be customized by specifying an environment variable named SEGMENT_DOWNLOAD_TIMEOUT_MINS with a timeout value in minutes.

env: SEGMENT_DOWNLOAD_TIMEOUT_MINS: '5' steps:

Check latest

In the basic examples above, the check-latest flag defaults to false. When set to false, the action tries to first resolve a version of Java from the local tool cache on the runner. If unable to find a specific version in the cache, the action will download a version of Java. Use the default or set check-latest to false if you prefer a faster more consistent setup experience that prioritizes trying to use the cached versions at the expense of newer versions sometimes being available for download.

If check-latest is set to true, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, the latest version of Java will be downloaded. Set check-latest to true if you want the most up-to-date version of Java to always be used. Setting check-latest to true has performance implications as downloading versions of Java is slower than using cached versions.

For Java distributions that are not cached on Hosted images, check-latest always behaves as true and downloads Java on-flight. Check out Hosted Tool Cache for more details about pre-cached Java versions.

steps:

Testing against different Java versions

jobs: build: runs-on: ubuntu-20.04 strategy: matrix: java: [ '8', '11', '17', '21' ] name: Java ${{ matrix.Java }} sample steps: - uses: actions/checkout@v4 - name: Setup java uses: actions/setup-java@v4 with: distribution: '' java-version: ${{ matrix.java }} - run: java HelloWorldApp.java

Install multiple JDKs

All versions are added to the PATH. The last version will be used and available globally. Other Java versions can be accessed through env variables with such specification as 'JAVA_HOME_{{ MAJOR_VERSION }}_{{ ARCHITECTURE }}'.

steps:
  - uses: actions/setup-java@v4
    with:
      distribution: '<distribution>'
      java-version: |
        8
        11
        15

Using Maven Toolchains

In the example above multiple JDKs are installed for the same job. The result after the last JDK is installed is a Maven Toolchains declaration containing references to all three JDKs. The values for id, version, and vendor of the individual Toolchain entries are the given input values for distribution and java-version (vendor being the combination of ${distribution}_${java-version}) by default.

Advanced Configuration

When using the setup-java action in your GitHub Actions workflow, it is recommended to set the following permissions to ensure proper functionality:

permissions: contents: read # access to check out code and install dependencies

License

The scripts and documentation in this project are released under the MIT License.

Contributions

Contributions are welcome! See Contributor's Guide