8048bbee47
Make it clearer that the action supports Scala |
||
---|---|---|
.github | ||
.licenses/npm | ||
__tests__ | ||
dist | ||
docs | ||
src | ||
.gitattributes | ||
.gitignore | ||
.licensed.yml | ||
.prettierrc.json | ||
action.yml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
jest.config.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json | ||
yaml-lint-config.yml |
setup-java
This action provides the following functionality for GitHub Actions runners:
- Downloading and setting up a requested version of Java. See Usage for a list of supported distributions
- Extracting and caching custom version of Java from a local file
- Configuring runner for publishing using Apache Maven
- Configuring runner for publishing using Gradle
- Configuring runner for using GPG private key
- Registering problem matchers for error output
- Caching dependencies managed by Apache Maven
- Caching dependencies managed by Gradle
- Caching dependencies managed by sbt
This action allows you to work with Java and Scala projects.
V2 vs V1
- V2 supports custom distributions and provides support for Zulu OpenJDK, Eclipse Temurin and Adopt OpenJDK out of the box. V1 supports only Zulu OpenJDK
- V2 requires you to specify distribution along with the version. V1 defaults to Zulu OpenJDK, only version input is required. Follow the migration guide to switch from V1 to V2
Usage
Inputs java-version
and distribution
are mandatory. See Supported distributions section for a list of available options.
Basic
Eclipse Temurin
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'temurin' # See 'Supported distributions' for available options
java-version: '17'
- run: java -cp java HelloWorldApp
Zulu OpenJDK
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'zulu' # See 'Supported distributions' for available options
java-version: '11'
- run: java -cp java HelloWorldApp
Supported version syntax
The java-version
input supports an exact version or a version range using SemVer notation:
- major versions:
8
,11
,16
,17
- more specific versions:
17.0
,11.0
,11.0.4
,8.0.232
,8.0.282+8
- early access (EA) versions:
15-ea
,15.0.0-ea
,15.0.0-ea.2
,15.0.0+2-ea
Supported distributions
Currently, the following distributions are supported:
Keyword | Distribution | Official site | License |
---|---|---|---|
temurin |
Eclipse Temurin | Link | Link |
zulu |
Zulu OpenJDK | Link | Link |
adopt or adopt-hotspot |
Adopt OpenJDK Hotspot | Link | Link |
adopt-openj9 |
Adopt OpenJDK OpenJ9 | Link | Link |
liberica |
Liberica JDK | Link | Link |
microsoft |
Microsoft Build of OpenJDK | Link | Link |
corretto |
Amazon Corretto Build of OpenJDK | 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: Adopt OpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from adopt
to temurin
to keep receiving software and security updates. See more details in the Good-bye AdoptOpenJDK post.
NOTE: For Zulu OpenJDK architectures x64 and arm64 are mapped to x86 / arm with proper hw_bitness.
Caching packages dependencies
The action has a built-in functionality for caching and restoring dependencies. It uses actions/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:
- gradle:
**/*.gradle*
,**/gradle-wrapper.properties
- maven:
**/pom.xml
- sbt: all sbt build definition files
**/*.sbt
,**/project/build.properties
,**/project/**.{scala,sbt}
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:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: '11'
cache: 'gradle'
- run: ./gradlew build --no-daemon
Caching maven dependencies
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: '11'
cache: 'maven'
- name: Build with Maven
run: mvn -B package --file pom.xml
Caching sbt dependencies
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: '11'
cache: 'sbt'
- name: Build with SBT
run: sbt package
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:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'adopt'
java-version: '11'
check-latest: true
- run: java -cp java HelloWorldApp
Testing against different Java versions
jobs:
build:
runs-on: ubuntu-20.04
strategy:
matrix:
java: [ '8', '11', '13', '15' ]
name: Java ${{ matrix.Java }} sample
steps:
- uses: actions/checkout@v3
- name: Setup java
uses: actions/setup-java@v3
with:
distribution: '<distribution>'
java-version: ${{ matrix.java }}
- run: java -cp java HelloWorldApp
Install multiple JDKs
steps:
- uses: actions/setup-java@v3
with:
distribution: '<distribution>'
java-version: 8
- run: echo "JAVA_8=$JAVA_HOME" >> $GITHUB_ENV
- uses: actions/setup-java@v3
with:
distribution: '<distribution>'
java-version: 11
- run: echo "JAVA_11=$JAVA_HOME" >> $GITHUB_ENV
- uses: actions/setup-java@v3
with:
distribution: '<distribution>'
java-version: 15
- run: echo "JAVA_15=$JAVA_HOME" >> $GITHUB_ENV
Advanced
- Selecting a Java distribution
- Installing custom Java package type
- Installing custom Java architecture
- Installing custom Java distribution from local file
- Testing against different Java distributions
- Testing against different platforms
- Publishing using Apache Maven
- Publishing using Gradle
- Hosted Tool Cache
License
The scripts and documentation in this project are released under the MIT License.
Contributions
Contributions are welcome! See Contributor's Guide