1
0
Fork 0
mirror of https://github.com/actions/setup-java.git synced 2024-08-16 10:19:51 +02:00
Find a file
Maxim Lobanov b53500dabc
Merge "v2-preview" branch into "main" (#150)
* actions/setup-java@v2 - Support different distributions (#132)

* Implement support for custom vendors in setup-java

* minor improvements

* minor refactoring

* Add unit tests and e2e tests

* Update documentation for setup-java@v2 release

* minor improvements

* regenerate dist

* fix comments

* resolve comments

* resolve comments

* fix tests

* Update README.md

Co-authored-by: George Adams <george.adams@microsoft.com>

* Apply suggestions from code review

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

* fix minor nitpicks

* handle 4th digit

* pull latest main

* Update README.md

* rename adoptium to adopt

* rename adoptium to adopt

* rename adoptium to adopt

* Update README.md

* make java-version and distribution required for action

* update readme

* fix tests

* fix e2e tests

Co-authored-by: George Adams <george.adams@microsoft.com>
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>

* Add "overwrite-settings" input parameter (#136)

* add overwrite-settings parameter

* fix e2e tests

* print debug

* fix e2e tests

* add comment

* remove comment

* Add "Contents/Home" postfix on macOS if provider creates it (#139)

* Update e2e-versions.yml

* Update e2e-versions.yml

* implement fix

* Update e2e-versions.yml

* Update installer.ts

* fix filter logic

* Update e2e-versions.yml

* remove extra logic

* Update e2e-versions.yml

* Add check-latest flag (#141)

* add changes for check-latest

* run prerelease script

* resolving comments

* fixing tests

* fix spelling

* improve core.info messages

* run format

* run prerelease

* change version to fix test

* resolve comment for check-latest

* Update README.md

* added hosted tool cache section

* Apply suggestions from code review

Co-authored-by: Maxim Lobanov <v-malob@microsoft.com>
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>

* Avoid "+" sign in Java path in v2-preview (#145)

* try to handle _ versions

* more logs

* more debug

* test 1

* more fixes

* fix typo

* Update e2e-versions.yml

* add unit-tests

* remove debug info from tests

* debug pre-cached versions

* change e2e tests to ubuntu-latest

* update npm licenses

Co-authored-by: George Adams <george.adams@microsoft.com>
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
Co-authored-by: Dmitry Shibanov <dmitry-shibanov@github.com>
2021-04-05 13:02:27 +03:00
.github Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
.licenses/npm Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
__tests__ Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
dist Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
docs Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
src Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +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 Add Licensed To Help Verify Prod Licenses (#88) 2020-09-23 23:23:32 +02:00
.prettierrc.json Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
action.yml Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +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 Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
package.json Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +03:00
README.md Merge "v2-preview" branch into "main" (#150) 2021-04-05 13:02:27 +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

V2 vs V1

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

Adopt OpenJDK

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

Zulu OpenJDK

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2-preview
  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 Adopt 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.

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-preview
  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-preview
        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