Merge 774eb61d1e into dded088883

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/basic-validation.yml

@@ -16,4 +16,4 @@ jobs:
     name: Basic validation
     uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
     with:
-      node-version: '20.x'
+      node-version: '24.x'

.github/workflows/check-dist.yml

@@ -16,4 +16,4 @@ jobs:
     name: Check dist/
     uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
     with:
-      node-version: '20.x'
+      node-version: '24.x'

.github/workflows/e2e-cache-dependency-path.yml

@@ -24,13 +24,13 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for gradle
         uses: ./
         id: setup-java
         with:
           distribution: 'adopt'
-          java-version: '11'
+          java-version: '17'
           cache: gradle
           cache-dependency-path: __tests__/cache/gradle1/*.gradle*
       - name: Create files to cache
@@ -51,7 +51,7 @@ jobs:
     needs: gradle1-save
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for gradle
         uses: ./
         id: setup-java
@@ -76,7 +76,7 @@ jobs:
     needs: gradle1-save
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for gradle
         uses: ./
         id: setup-java

.github/workflows/e2e-cache.yml

@@ -24,13 +24,13 @@ jobs:
         os: [macos-13, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for gradle
         uses: ./
         id: setup-java
         with:
           distribution: 'adopt'
-          java-version: '11'
+          java-version: '17'
           cache: gradle
       - name: Create files to cache
         # Need to avoid using Gradle daemon to stabilize the save process on Windows
@@ -50,7 +50,7 @@ jobs:
     needs: gradle-save
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for gradle
         uses: ./
         id: setup-java
@@ -73,7 +73,7 @@ jobs:
         os: [macos-13, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for maven
         uses: ./
         id: setup-java
@@ -97,7 +97,7 @@ jobs:
     needs: maven-save
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for maven
         uses: ./
         id: setup-java
@@ -124,7 +124,7 @@ jobs:
         os: [macos-13, windows-latest, ubuntu-22.04]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for sbt
         uses: ./
         id: setup-java
@@ -174,7 +174,7 @@ jobs:
     needs: sbt-save
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run setup-java with the cache for sbt
         uses: ./
         id: setup-java

.github/workflows/e2e-local-file.yml

@@ -21,7 +21,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Download Adopt OpenJDK file
         run: |
           if ($IsLinux) {
@@ -58,7 +58,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Download Zulu OpenJDK file
         run: |
           if ($IsLinux) {
@@ -95,7 +95,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Download Eclipse Temurin file
         run: |
           if ($IsLinux) {

.github/workflows/e2e-publishing.yml

@@ -25,7 +25,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -60,7 +60,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create fake settings.xml
         run: |
           $xmlDirectory = Join-Path $HOME ".m2"
@@ -96,7 +96,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create fake settings.xml
         run: |
           $xmlDirectory = Join-Path $HOME ".m2"
@@ -133,7 +133,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java

.github/workflows/e2e-versions.yml

@@ -64,7 +64,7 @@ jobs:
             version: '24-ea'
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -114,7 +114,7 @@ jobs:
             version: '17.0.7'
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -149,7 +149,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -185,7 +185,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -224,7 +224,7 @@ jobs:
         version: ['17-ea', '15.0.0-ea.14']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -246,7 +246,7 @@ jobs:
         version: ['17-ea']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -268,7 +268,7 @@ jobs:
         version: ['17-ea', '21-ea']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -355,7 +355,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -383,7 +383,7 @@ jobs:
         version: ['11']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: setup-java
         uses: ./
         id: setup-java
@@ -406,7 +406,7 @@ jobs:
         java-version-file: ['.java-version', '.tool-versions']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create .java-version file
         shell: bash
         run: echo "17" > .java-version
@@ -435,7 +435,7 @@ jobs:
         java-version-file: ['.java-version', '.tool-versions']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create .java-version file
         shell: bash
         run: echo "11" > .java-version
@@ -463,7 +463,7 @@ jobs:
         java-version-file: ['.java-version', '.tool-versions']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create .java-version file
         shell: bash
         run: echo "17.0.10" > .java-version
@@ -491,7 +491,7 @@ jobs:
         java-version-file: ['.java-version', '.tool-versions']
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Create .java-version file
         shell: bash
         run: echo "openjdk64-17.0.10" > .java-version

.github/workflows/publish-immutable-actions.yml

@@ -2,7 +2,8 @@ name: 'Publish Immutable Action Version'
 
 on:
   release:
-    types: [published]
+    types: [released]
+  workflow_dispatch:
 
 jobs:
   publish:
@@ -14,7 +15,7 @@ jobs:
 
     steps:
       - name: Checking out
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Publish
         id: publish
         uses: actions/publish-immutable-action@v0.0.4

README.md

@@ -46,7 +46,13 @@ This action allows you to work with Java and Scala projects.
   #### Maven options
   The action has a bunch of inputs to generate maven's [settings.xml](https://maven.apache.org/settings.html) on the fly and pass the values to Apache Maven GPG Plugin as well as Apache Maven Toolchains. See [advanced usage](docs/advanced-usage.md) for more.
 
-  - `overwrite-settings`: By default action overwrites the settings.xml. In order to skip generation of file if it exists, set this to `false`.
+  - `overwrite-settings`: By default action overwrites the settings.xml and adds a toolchain entry to toolchains.xml. In order to skip generation of settings.xml and skip adding a toolchain entry to toolchains.xml if the according file exists, set this to `false`.
+
+  - `update-env-javahome`: By default action updates `env.JAVA_HOME` with the path of java installed. In order to skip update of JAVA_HOME, set this to `false`. The creation of the env variable JAVA_HOME_{{ MAJOR_VERSION }}_{{ ARCHITECTURE }} is NOT affected by this item. That will be created for any setup.
+
+  - `update-env-path`: By default action adds `<java_install_dir>/bin` to `env.PATH`. In order to skip this, set this to `false`.
+
+  - `update-toolchains-only`: If set to true, then `overwrite-settings`, `update-env-javahome` and `update-env-path` are propagated to `false` if the specific one is not explicitly configured to `true`. Only a toolchain entry will be added to toolchains.xml. Default is `false`.
 
   - `server-id`: ID of the distributionManagement repository in the pom.xml file. Default is `github`.
 
@@ -235,7 +241,7 @@ jobs:
 
 ### 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 }}'.
+By default 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 }}'.
 
 ```yaml
     steps:
@@ -248,6 +254,8 @@ All versions are added to the PATH. The last version will be used and available
             15
 ```
 
+**NOTE:** An alternative option is to use multiple setup-java steps. In this case the behavior can be controlled more granular by making use of the input items `overwrite-settings`, `update-env-javahome`, `update-env-path` and `update-toolchains-only`.
+
 ### 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.
 

__tests__/distributors/adopt-installer.test.ts

@@ -191,7 +191,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const installerOptions: JavaInstallerOptions = {
         version: '17',

__tests__/distributors/base-installer.test.ts

@@ -287,7 +287,7 @@ describe('setupJava', () => {
     spyCoreSetOutput = jest.spyOn(core, 'setOutput');
     spyCoreSetOutput.mockImplementation(() => undefined);
 
-    jest.spyOn(os, 'arch').mockReturnValue('x86');
+    jest.spyOn(os, 'arch').mockReturnValue('x86' as ReturnType<typeof os.arch>);
   });
 
   afterEach(() => {

__tests__/distributors/corretto-installer.test.ts

@@ -203,28 +203,27 @@ describe('getAvailableVersions', () => {
     });
 
     it.each([
-      ['arm64', 'aarch64'],
-      ['amd64', 'x64']
+      ['amd64', 'x64'],
+      ['arm64', 'aarch64']
     ])(
       'defaults to os.arch(): %s mapped to distro arch: %s',
       async (osArch: string, distroArch: string) => {
-        jest.spyOn(os, 'arch').mockReturnValue(osArch);
+        jest
+          .spyOn(os, 'arch')
+          .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
-        const version = '17';
-        const installerOptions: JavaInstallerOptions = {
-          version,
+        const distribution = new CorrettoDistribution({
+          version: '17',
           architecture: '', // to get default value
           packageType: 'jdk',
           checkLatest: false
-        };
-
-        const distribution = new CorrettoDistribution(installerOptions);
+        });
         mockPlatform(distribution, 'macos');
 
         const expectedLink = `https://corretto.aws/downloads/resources/17.0.2.8.1/amazon-corretto-17.0.2.8.1-macosx-${distroArch}.tar.gz`;
 
         const availableVersion = await distribution['findPackageForDownload'](
-          version
+          '17'
         );
         expect(availableVersion).not.toBeNull();
         expect(availableVersion.url).toBe(expectedLink);

__tests__/distributors/graalvm-installer.test.ts

@@ -98,31 +98,35 @@ describe('findPackageForDownload', () => {
   });
 
   it.each([
-    ['amd64', 'x64'],
-    ['arm64', 'aarch64']
+    ['amd64', ['x64', 'amd64']],
+    ['arm64', ['aarch64', 'arm64']]
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
-    async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
-      jest.spyOn(os, 'platform').mockReturnValue('linux');
+    async (osArch: string, distroArchs: string[]) => {
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
-      const version = '21';
-      const distro = new GraalVMDistribution({
-        version,
+      const distribution = new GraalVMDistribution({
+        version: '21',
         architecture: '', // to get default value
         packageType: 'jdk',
         checkLatest: false
       });
 
       const osType = distribution.getPlatform();
-      if (osType === 'windows' && distroArch == 'aarch64') {
+      if (osType === 'windows' && distroArchs.includes('aarch64')) {
         return; // skip, aarch64 is not available for Windows
       }
       const archiveType = getDownloadArchiveExtension();
-      const result = await distro['findPackageForDownload'](version);
-      const expectedUrl = `https://download.oracle.com/graalvm/21/latest/graalvm-jdk-21_${osType}-${distroArch}_bin.${archiveType}`;
+      const result = await distribution['findPackageForDownload']('21');
 
-      expect(result.url).toBe(expectedUrl);
+      const expectedUrls = distroArchs.map(
+        distroArch =>
+          `https://download.oracle.com/graalvm/21/latest/graalvm-jdk-21_${osType}-${distroArch}_bin.${archiveType}`
+      );
+
+      expect(expectedUrls).toContain(result.url);
     }
   );
 

__tests__/distributors/jetbrains-installer.test.ts

@@ -41,9 +41,7 @@ describe('getAvailableVersions', () => {
     expect(availableVersions).not.toBeNull();
 
     const length =
-      os.platform() === 'win32'
-        ? manifestData.length - 1
-        : manifestData.length + 1;
+      os.platform() === 'win32' ? manifestData.length : manifestData.length + 2;
     expect(availableVersions.length).toBe(length);
   }, 10_000);
 });

__tests__/distributors/liberica-installer.test.ts

@@ -105,9 +105,11 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
-      const distribution = new LibericaDistributions({
+      const distributions = new LibericaDistributions({
         version: '17',
         architecture: '', // to get default value
         packageType: 'jdk',
@@ -117,11 +119,11 @@ describe('getAvailableVersions', () => {
       const additionalParams =
         '&installation-type=archive&fields=downloadUrl%2Cversion%2CfeatureVersion%2CinterimVersion%2C' +
         'updateVersion%2CbuildVersion';
-      distribution['getPlatformOption'] = () => 'macos';
+      distributions['getPlatformOption'] = () => 'macos';
 
       const buildUrl = `https://api.bell-sw.com/v1/liberica/releases?os=macos&bundle-type=jdk&bitness=${distroArch.bitness}&arch=${distroArch.arch}&build-type=all${additionalParams}`;
 
-      await distribution['getAvailableVersions']();
+      await distributions['getAvailableVersions']();
 
       expect(spyHttpClient.mock.calls).toHaveLength(1);
       expect(spyHttpClient.mock.calls[0][0]).toBe(buildUrl);

__tests__/distributors/liberica-linux-installer.test.ts

@@ -105,7 +105,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const distribution = new LibericaDistributions({
         version: '17',

__tests__/distributors/liberica-windows-installer.test.ts

@@ -105,7 +105,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const distribution = new LibericaDistributions({
         version: '17',

__tests__/distributors/microsoft-installer.test.ts

@@ -95,7 +95,9 @@ describe('findPackageForDownload', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
       jest.spyOn(os, 'platform').mockReturnValue('darwin');
 
       const version = '17';
@@ -119,7 +121,9 @@ describe('findPackageForDownload', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
       jest.spyOn(os, 'platform').mockReturnValue('linux');
 
       const version = '17';
@@ -143,7 +147,9 @@ describe('findPackageForDownload', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
       jest.spyOn(os, 'platform').mockReturnValue('win32');
 
       const version = '17';

__tests__/distributors/oracle-installer.test.ts

@@ -95,7 +95,9 @@ describe('findPackageForDownload', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
       jest.spyOn(os, 'platform').mockReturnValue('linux');
 
       const version = '18';

__tests__/distributors/temurin-installer.test.ts

@@ -147,7 +147,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: string) => {
-      jest.spyOn(os, 'arch').mockReturnValue(distroArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const installerOptions: JavaInstallerOptions = {
         version: '17',

__tests__/distributors/zulu-installer.test.ts

@@ -1,5 +1,4 @@
 import {HttpClient} from '@actions/http-client';
-import * as semver from 'semver';
 import {ZuluDistribution} from '../../src/distributions/zulu/installer';
 import {IZuluVersions} from '../../src/distributions/zulu/models';
 import * as utils from '../../src/util';
@@ -126,7 +125,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const distribution = new ZuluDistribution({
         version: '17',

__tests__/distributors/zulu-linux-installer.test.ts

@@ -126,7 +126,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const distribution = new ZuluDistribution({
         version: '17',
@@ -135,7 +137,9 @@ describe('getAvailableVersions', () => {
         checkLatest: false
       });
       distribution['getPlatformOption'] = () => 'linux';
-      const buildUrl = `https://api.azul.com/zulu/download/community/v1.0/bundles/?os=linux&ext=zip&bundle_type=jdk&javafx=false&arch=${distroArch.arch}&hw_bitness=${distroArch.bitness}&release_status=ga`;
+      // Override extension for linux default arch case to match util behavior
+      spyUtilGetDownloadArchiveExtension.mockReturnValue('tar.gz');
+      const buildUrl = `https://api.azul.com/zulu/download/community/v1.0/bundles/?os=linux&ext=tar.gz&bundle_type=jdk&javafx=false&arch=${distroArch.arch}&hw_bitness=${distroArch.bitness}&release_status=ga`;
 
       await distribution['getAvailableVersions']();
 

__tests__/distributors/zulu-windows-installer.test.ts

@@ -126,7 +126,9 @@ describe('getAvailableVersions', () => {
   ])(
     'defaults to os.arch(): %s mapped to distro arch: %s',
     async (osArch: string, distroArch: DistroArch) => {
-      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest
+        .spyOn(os, 'arch')
+        .mockReturnValue(osArch as ReturnType<typeof os.arch>);
 
       const distribution = new ZuluDistribution({
         version: '17',

action.yml

@@ -43,9 +43,21 @@ inputs:
     description: 'Path to where the settings.xml file will be written. Default is ~/.m2.'
     required: false
   overwrite-settings:
-    description: 'Overwrite the settings.xml file if it exists. Default is "true".'
+    description: 'Overwrite the settings.xml file if it exists. Default is "!update-toolchains-only". If explcitly set "true", it will update settings.xml regardless of "update-toolchains-only"'
     required: false
-    default: true
+    # DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
+  update-toolchains-only:
+    description: 'Update toolchains.xml only. Default is "false". No update of settings.xml, no update of JAVA_HOME, no adding to PATH by default - unless "overwrite-settings", "update-env-javahome" or "add-to-env-path" are not explicitly set "true"'
+    required: false
+    default: false
+  update-env-javahome:
+    description: 'Update the JAVA_HOME environment variable. Default is "!update-toolchains-only"'
+    required: false
+    # DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
+  add-to-env-path:
+    description: 'Add "<JDK home>/bin" to the PATH environment variable. Default is "!update-toolchains-only"'
+    required: false
+    # DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
   gpg-private-key:
     description: 'GPG private key to import. Default is empty string.'
     required: false
@@ -81,6 +93,6 @@ outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'
 runs:
-  using: 'node20'
+  using: 'node24'
   main: 'dist/setup/index.js'
   post: 'dist/cleanup/index.js'

package.json

@@ -1,9 +1,12 @@
 {
   "name": "setup-java",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "private": true,
   "description": "setup java action",
   "main": "dist/setup/index.js",
+   "engines": {
+    "node": ">=24.0.0"
+  },
   "scripts": {
     "build": "ncc build -o dist/setup src/setup-java.ts && ncc build -o dist/cleanup src/cleanup-java.ts",
     "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write \"**/*.{ts,yml,yaml}\"",
@@ -26,10 +29,10 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^4.0.2",
+    "@actions/cache": "^4.0.3",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.0.4",
-    "@actions/glob": "^0.4.0",
+    "@actions/glob": "^0.5.0",
     "@actions/http-client": "^2.2.3",
     "@actions/io": "^1.0.2",
     "@actions/tool-cache": "^2.0.1",
@@ -38,19 +41,19 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.11.24",
+    "@types/node": "^24.1.0",
     "@types/semver": "^7.5.8",
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "@typescript-eslint/parser": "^5.54.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.1",
+    "@typescript-eslint/parser": "^8.35.1",
     "@vercel/ncc": "^0.38.1",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jest": "^29.0.1",
     "eslint-plugin-node": "^11.1.0",
     "jest": "^29.7.0",
     "jest-circus": "^29.7.0",
     "prettier": "^2.8.4",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.3.0",
     "typescript": "^5.3.3"
   },
   "bugs": {

src/auth.ts

@@ -10,17 +10,13 @@ import * as constants from './constants';
 import * as gpg from './gpg';
 import {getBooleanInput} from './util';
 
-export async function configureAuthentication() {
+export async function configureAuthentication(overwriteSettings: boolean) {
   const id = core.getInput(constants.INPUT_SERVER_ID);
   const username = core.getInput(constants.INPUT_SERVER_USERNAME);
   const password = core.getInput(constants.INPUT_SERVER_PASSWORD);
   const settingsDirectory =
     core.getInput(constants.INPUT_SETTINGS_PATH) ||
     path.join(os.homedir(), constants.M2_DIR);
-  const overwriteSettings = getBooleanInput(
-    constants.INPUT_OVERWRITE_SETTINGS,
-    true
-  );
   const gpgPrivateKey =
     core.getInput(constants.INPUT_GPG_PRIVATE_KEY) ||
     constants.INPUT_DEFAULT_GPG_PRIVATE_KEY;

src/constants.ts

@@ -11,6 +11,9 @@ export const INPUT_SERVER_USERNAME = 'server-username';
 export const INPUT_SERVER_PASSWORD = 'server-password';
 export const INPUT_SETTINGS_PATH = 'settings-path';
 export const INPUT_OVERWRITE_SETTINGS = 'overwrite-settings';
+export const INPUT_UPDATE_TOOLCHAINS_ONLY = 'update-toolchains-only';
+export const INPUT_UPDATE_JAVA_HOME = 'update-env-javahome';
+export const INPUT_ADD_TO_PATH = 'add-to-env-path';
 export const INPUT_GPG_PRIVATE_KEY = 'gpg-private-key';
 export const INPUT_GPG_PASSPHRASE = 'gpg-passphrase';
 

src/distributions/base-installer.ts

@@ -10,7 +10,11 @@ import {
   JavaInstallerOptions,
   JavaInstallerResults
 } from './base-models';
-import {MACOS_JAVA_CONTENT_POSTFIX} from '../constants';
+import {
+  MACOS_JAVA_CONTENT_POSTFIX,
+  INPUT_UPDATE_JAVA_HOME,
+  INPUT_ADD_TO_PATH
+} from '../constants';
 import os from 'os';
 
 export abstract class JavaBase {
@@ -20,6 +24,8 @@ export abstract class JavaBase {
   protected packageType: string;
   protected stable: boolean;
   protected checkLatest: boolean;
+  protected updateEnvJavaHome: boolean;
+  protected addToEnvPath: boolean;
 
   constructor(
     protected distribution: string,
@@ -36,6 +42,8 @@ export abstract class JavaBase {
     this.architecture = installerOptions.architecture || os.arch();
     this.packageType = installerOptions.packageType;
     this.checkLatest = installerOptions.checkLatest;
+    this.updateEnvJavaHome = installerOptions.updateEnvJavaHome;
+    this.addToEnvPath = installerOptions.addToEnvPath;
   }
 
   protected abstract downloadTool(
@@ -51,14 +59,36 @@ export abstract class JavaBase {
       core.info(`Resolved Java ${foundJava.version} from tool-cache`);
     } else {
       core.info('Trying to resolve the latest version from remote');
-      const javaRelease = await this.findPackageForDownload(this.version);
-      core.info(`Resolved latest version as ${javaRelease.version}`);
-      if (foundJava?.version === javaRelease.version) {
-        core.info(`Resolved Java ${foundJava.version} from tool-cache`);
-      } else {
-        core.info('Trying to download...');
-        foundJava = await this.downloadTool(javaRelease);
-        core.info(`Java ${foundJava.version} was downloaded`);
+      try {
+        const javaRelease = await this.findPackageForDownload(this.version);
+        core.info(`Resolved latest version as ${javaRelease.version}`);
+        if (foundJava?.version === javaRelease.version) {
+          core.info(`Resolved Java ${foundJava.version} from tool-cache`);
+        } else {
+          core.info('Trying to download...');
+          foundJava = await this.downloadTool(javaRelease);
+          core.info(`Java ${foundJava.version} was downloaded`);
+        }
+      } catch (error: any) {
+        if (error instanceof tc.HTTPError) {
+          if (error.httpStatusCode === 403) {
+            core.error('HTTP 403: Permission denied or access restricted.');
+          } else if (error.httpStatusCode === 429) {
+            core.warning('HTTP 429: Rate limit exceeded. Please retry later.');
+          } else {
+            core.error(`HTTP ${error.httpStatusCode}: ${error.message}`);
+          }
+        } else {
+          const message =
+            error instanceof Error ? error.message : JSON.stringify(error);
+          core.error(
+            `Java setup failed due to network issue or timeout: ${message}`
+          );
+        }
+        if (error instanceof Error && error.stack) {
+          core.debug(error.stack);
+        }
+        throw error;
       }
     }
 
@@ -163,8 +193,18 @@ export abstract class JavaBase {
 
   protected setJavaDefault(version: string, toolPath: string) {
     const majorVersion = version.split('.')[0];
-    core.exportVariable('JAVA_HOME', toolPath);
-    core.addPath(path.join(toolPath, 'bin'));
+    if (this.updateEnvJavaHome) {
+      core.exportVariable('JAVA_HOME', toolPath);
+    } else {
+      core.info(
+        `Skip updating env.JAVA_HOME according to ${INPUT_UPDATE_JAVA_HOME}`
+      );
+    }
+    if (this.addToEnvPath) {
+      core.addPath(path.join(toolPath, 'bin'));
+    } else {
+      core.info(`Skip adding to env.PATH according to ${INPUT_ADD_TO_PATH}`);
+    }
     core.setOutput('distribution', this.distribution);
     core.setOutput('path', toolPath);
     core.setOutput('version', version);

src/distributions/base-models.ts

@@ -3,6 +3,8 @@ export interface JavaInstallerOptions {
   architecture: string;
   packageType: string;
   checkLatest: boolean;
+  updateEnvJavaHome: boolean;
+  addToEnvPath: boolean;
 }
 
 export interface JavaInstallerResults {

src/distributions/jetbrains/installer.ts

@@ -113,9 +113,18 @@ export class JetBrainsDistribution extends JavaBase {
         core.debug(`Gathering available versions from '${rawUrl}'`);
       }
 
-      const paginationPage = (
+      const paginationPageResult = (
         await this.http.getJson<IJetBrainsRawVersion[]>(rawUrl, requestHeaders)
       ).result;
+      if (!paginationPageResult || paginationPageResult.length === 0) {
+        // break infinity loop because we have reached end of pagination
+        break;
+      }
+
+      const paginationPage: IJetBrainsRawVersion[] =
+        paginationPageResult.filter(version =>
+          this.stable ? !version.prerelease : version.prerelease
+        );
       if (!paginationPage || paginationPage.length === 0) {
         // break infinity loop because we have reached end of pagination
         break;
@@ -125,9 +134,13 @@ export class JetBrainsDistribution extends JavaBase {
       page_index++;
     }
 
-    // Add versions not available from the API but are downloadable
-    const hidden = ['11_0_10b1145.115', '11_0_11b1341.60'];
-    rawVersions.push(...hidden.map(tag => ({tag_name: tag, name: tag})));
+    if (this.stable) {
+      // Add versions not available from the API but are downloadable
+      const hidden = ['11_0_10b1145.115', '11_0_11b1341.60'];
+      rawVersions.push(
+        ...hidden.map(tag => ({tag_name: tag, name: tag, prerelease: false}))
+      );
+    }
 
     const versions0 = rawVersions.map(async v => {
       // Release tags look like one of these:
@@ -148,7 +161,7 @@ export class JetBrainsDistribution extends JavaBase {
 
       const vsplit = vstring.split('b');
       let semver = vsplit[0];
-      const build = +vsplit[1];
+      const build = vsplit[1];
 
       // Normalize semver
       if (!semver.includes('.') && !semver.includes('_'))

src/distributions/jetbrains/models.ts

@@ -3,11 +3,12 @@
 export interface IJetBrainsRawVersion {
   tag_name: string;
   name: string;
+  prerelease: boolean;
 }
 
 export interface IJetBrainsVersion {
   tag_name: string;
   semver: string;
-  build: number;
+  build: string;
   url: string;
 }

src/distributions/microsoft/installer.ts

@@ -116,7 +116,7 @@ export class MicrosoftDistributions extends JavaBase {
       }
     } catch (err) {
       core.debug(
-        `Http request for microsoft-openjdk-versions.json failed with status code: ${response?.statusCode}`
+        `Http request for microsoft-openjdk-versions.json failed with status code: ${response?.statusCode}. Error: ${err}`
       );
       return null;
     }

src/setup-java.ts

@@ -13,6 +13,19 @@ import * as path from 'path';
 import {getJavaDistribution} from './distributions/distribution-factory';
 import {JavaInstallerOptions} from './distributions/base-models';
 
+interface IInstallerInputsOptions {
+  architecture: string;
+  packageType: string;
+  checkLatest: boolean;
+  distributionName: string;
+  jdkFile: string;
+  toolchainIds: Array<string>;
+  updateToolchainsOnly: boolean;
+  overwriteSettings: boolean;
+  updateEnvJavaHome: boolean;
+  addToEnvPath: boolean;
+}
+
 async function run() {
   try {
     const versions = core.getMultilineInput(constants.INPUT_JAVA_VERSION);
@@ -28,6 +41,23 @@ async function run() {
       constants.INPUT_CACHE_DEPENDENCY_PATH
     );
     const checkLatest = getBooleanInput(constants.INPUT_CHECK_LATEST, false);
+    const updateToolchainsOnly = getBooleanInput(
+      constants.INPUT_UPDATE_TOOLCHAINS_ONLY,
+      false
+    );
+    const overwriteSettings = getBooleanInput(
+      constants.INPUT_OVERWRITE_SETTINGS,
+      !updateToolchainsOnly
+    );
+    const updateEnvJavaHome = getBooleanInput(
+      constants.INPUT_UPDATE_JAVA_HOME,
+      !updateToolchainsOnly
+    );
+    const addToEnvPath = getBooleanInput(
+      constants.INPUT_ADD_TO_PATH,
+      !updateToolchainsOnly
+    );
+
     let toolchainIds = core.getMultilineInput(constants.INPUT_MVN_TOOLCHAIN_ID);
 
     core.startGroup('Installed distributions');
@@ -40,13 +70,17 @@ async function run() {
       throw new Error('java-version or java-version-file input expected');
     }
 
-    const installerInputsOptions: installerInputsOptions = {
+    const installerInputsOptions: IInstallerInputsOptions = {
       architecture,
       packageType,
       checkLatest,
       distributionName,
       jdkFile,
-      toolchainIds
+      toolchainIds,
+      updateToolchainsOnly,
+      overwriteSettings,
+      updateEnvJavaHome,
+      addToEnvPath
     };
 
     if (!versions.length) {
@@ -78,7 +112,7 @@ async function run() {
     const matchersPath = path.join(__dirname, '..', '..', '.github');
     core.info(`##[add-matcher]${path.join(matchersPath, 'java.json')}`);
 
-    await auth.configureAuthentication();
+    await auth.configureAuthentication(overwriteSettings);
     if (cache && isCacheFeatureAvailable()) {
       await restore(cache, cacheDependencyPath);
     }
@@ -91,7 +125,7 @@ run();
 
 async function installVersion(
   version: string,
-  options: installerInputsOptions,
+  options: IInstallerInputsOptions,
   toolchainId = 0
 ) {
   const {
@@ -100,14 +134,20 @@ async function installVersion(
     architecture,
     packageType,
     checkLatest,
-    toolchainIds
+    toolchainIds,
+    updateToolchainsOnly,
+    overwriteSettings,
+    updateEnvJavaHome,
+    addToEnvPath
   } = options;
 
   const installerOptions: JavaInstallerOptions = {
+    version,
     architecture,
     packageType,
     checkLatest,
-    version
+    updateEnvJavaHome,
+    addToEnvPath
   };
 
   const distribution = getJavaDistribution(
@@ -126,6 +166,7 @@ async function installVersion(
     version,
     distributionName,
     result.path,
+    overwriteSettings || updateToolchainsOnly,
     toolchainIds[toolchainId]
   );
 
@@ -136,12 +177,3 @@ async function installVersion(
   core.info(`  Path: ${result.path}`);
   core.info('');
 }
-
-interface installerInputsOptions {
-  architecture: string;
-  packageType: string;
-  checkLatest: boolean;
-  distributionName: string;
-  jdkFile: string;
-  toolchainIds: Array<string>;
-}

src/toolchains.ts

@@ -19,6 +19,7 @@ export async function configureToolchains(
   version: string,
   distributionName: string,
   jdkHome: string,
+  updateToolchains: boolean,
   toolchainId?: string
 ) {
   const vendor =
@@ -27,10 +28,6 @@ export async function configureToolchains(
   const settingsDirectory =
     core.getInput(constants.INPUT_SETTINGS_PATH) ||
     path.join(os.homedir(), constants.M2_DIR);
-  const overwriteSettings = getBooleanInput(
-    constants.INPUT_OVERWRITE_SETTINGS,
-    true
-  );
 
   await createToolchainsSettings({
     jdkInfo: {
@@ -40,21 +37,21 @@ export async function configureToolchains(
       jdkHome
     },
     settingsDirectory,
-    overwriteSettings
+    updateToolchains
   });
 }
 
 export async function createToolchainsSettings({
   jdkInfo,
   settingsDirectory,
-  overwriteSettings
+  updateToolchains
 }: {
   jdkInfo: JdkInfo;
   settingsDirectory: string;
-  overwriteSettings: boolean;
+  updateToolchains: boolean;
 }) {
   core.info(
-    `Creating ${constants.MVN_TOOLCHAINS_FILE} for JDK version ${jdkInfo.version} from ${jdkInfo.vendor}`
+    `Adding a toolchain entry in ${constants.MVN_TOOLCHAINS_FILE} for JDK version ${jdkInfo.version} from ${jdkInfo.vendor}`
   );
   // when an alternate m2 location is specified use only that location (no .m2 directory)
   // otherwise use the home/.m2/ path
@@ -72,7 +69,7 @@ export async function createToolchainsSettings({
   await writeToolchainsFileToDisk(
     settingsDirectory,
     updatedToolchains,
-    overwriteSettings
+    updateToolchains
   );
 }
 
@@ -147,17 +144,17 @@ async function readExistingToolchainsFile(directory: string) {
 async function writeToolchainsFileToDisk(
   directory: string,
   settings: string,
-  overwriteSettings: boolean
+  updateToolchains: boolean
 ) {
   const location = path.join(directory, constants.MVN_TOOLCHAINS_FILE);
-  const settingsExists = fs.existsSync(location);
-  if (settingsExists && overwriteSettings) {
-    core.info(`Overwriting existing file ${location}`);
-  } else if (!settingsExists) {
-    core.info(`Writing to ${location}`);
+  const toolchainsExists = fs.existsSync(location);
+  if (toolchainsExists && updateToolchains) {
+    core.info(`Updating existing file ${location}`);
+  } else if (!toolchainsExists) {
+    core.info(`Creating file ${location}`);
   } else {
     core.info(
-      `Skipping generation of ${location} because file already exists and overwriting is not enabled`
+      `Skipping update of ${location} since file already exists and updating is not enabled`
     );
     return;
   }