Set up your GitHub Actions workflow with a specific version of Java
Find a file
Kengo TODA 08e4e813b8
Introduce the dependency caching for Maven and Gradle (#193)
* implement a core logic to cache dependnecies

* integrate the cache logic to entry points

* add a user doc about the dependency cache feature

* reflect changes to the dist dir

* add a prefix to the cache key

https://github.com/actions/setup-java/pull/193/files#r669521434

* test: extract build.gradle to a file in __tests__ dir

* run the restore e2e test on the specified OS

* add an e2e test for maven

* fix the dependency among workflows

* stabilize the cache on the Windows in e2e test

* add .gitignore files to __tests__/cache directories

* try to run restore after the authentication

* use the key in state to save caches in the post process

* suggest users to run without daemon if fail to save Gradle cache on Windows

* add missing description in the README.md

* run clean-up tasks in serial

* Add validation for post step (#3)

* work on fixing cache post step

* fix tests

* Update src/cleanup-java.ts

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>

* Update src/cache.ts

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>

* style: put the name of input to the constants.ts

* format: run `npm run build` to reflect changes to the dist dir

* chore: update licensed files by `licensed cache`

it still has three errors as follows:
>* setup-java.npm.sax
>  filename: /Users/kengo/GitHub/setup-java/.licenses/npm/sax.dep.yml
>    - license needs review: other
>
>* setup-java.npm.tslib-1.14.1
>  filename: /Users/kengo/GitHub/setup-java/.licenses/npm/tslib-1.14.1.dep.yml
>    - license needs review: 0bsd
>
>* setup-java.npm.tslib-2.3.0
>  filename: /Users/kengo/GitHub/setup-java/.licenses/npm/tslib-2.3.0.dep.yml
>    - license needs review: 0bsd

* fix: rerun ncc on macOS with node v12

* build: follow the suggestion at PR page

https://github.com/actions/setup-java/pull/193#issuecomment-901839546

* fix: throw error in case of no package manager file found

Co-authored-by: Dmitry Shibanov <dmitry-shibanov@github.com>
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
2021-08-19 20:19:35 +03:00
.github Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
.licenses/npm Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
__tests__ Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
dist Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
docs Improve README and advanced usage guide (#174) 2021-05-17 16:38:02 +03:00
src Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
.gitattributes Add Licensed To Help Verify Prod Licenses (#88) 2020-09-23 23:23:32 +02:00
.gitignore ignore vscode directory 2019-11-28 13:35:47 -08:00
.licensed.yml Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
.prettierrc.json Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
action.yml Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
CONTRIBUTING.md Add Licensed To Help Verify Prod Licenses (#88) 2020-09-23 23:23:32 +02:00
jest.config.js Populate repo 2019-07-10 10:54:25 -04:00
LICENSE Populate repo 2019-07-10 10:54:25 -04:00
package-lock.json Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
package.json Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
README.md Introduce the dependency caching for Maven and Gradle (#193) 2021-08-19 20:19:35 +03:00
tsconfig.json Populate repo 2019-07-10 10:54:25 -04:00
yaml-lint-config.yml Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00

setup-java

GitHub Actions status

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

V2 vs V1

  • V2 supports custom distributions and provides support for Zulu OpenJDK, Adopt OpenJDK and Eclipse Temurin 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

Adopt OpenJDK

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
  with:
    distribution: 'adopt' # See 'Supported distributions' for available options
    java-version: '11'
- run: java -cp java HelloWorldApp

Eclipse Temurin

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
  with:
    distribution: 'temurin' # See 'Supported distributions' for available options
    java-version: '8'
- run: java -cp java HelloWorldApp

Zulu OpenJDK

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
  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, 15
  • more specific versions: 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
zulu Zulu OpenJDK Link Link
adopt or adopt-hotspot Adopt OpenJDK Hotspot Link Link
adopt-openj9 Adopt OpenJDK OpenJ9 Link Link
temurin Eclipse Temurin 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.

Supported cache types

Currently, gradle and maven are supported. You can set cache input like below:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
  with:
    distribution: 'adopt'
    java-version: '11'
    cache: 'gradle' # will restore cache of dependencies and wrappers
- run: ./gradlew build

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@v2
- uses: actions/setup-java@v2
  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@v2
      - name: Setup java
        uses: actions/setup-java@v2
        with:
          distribution: '<distribution>'
          java-version: ${{ matrix.java }}
      - run: java -cp java HelloWorldApp

Advanced

License

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

Contributions

Contributions are welcome! See Contributor's Guide