Deprecate setup-java v3 (#1195)

Add a deprecation message to the v3 action metadata and emit a runtime warning that v3 will no longer receive updates, directing users to migrate to setup-java v5.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

.github/workflows/basic-validation.yml

@@ -15,5 +15,3 @@ jobs:
   call-basic-validation:
     name: Basic validation
     uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
-    with:
-      node-version: '20.x'

.github/workflows/check-dist.yml

@@ -15,5 +15,3 @@ jobs:
   call-check-dist:
     name: Check dist/
     uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
-    with:
-      node-version: '20.x'

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

@@ -1,93 +0,0 @@
-name: Validate cache with cache-dependency-path option
-
-on:
-  push:
-    branches:
-      - main
-      - releases/*
-    paths-ignore:
-      - '**.md'
-  pull_request:
-    paths-ignore:
-      - '**.md'
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  gradle1-save:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Run setup-java with the cache for gradle
-        uses: ./
-        id: setup-java
-        with:
-          distribution: 'adopt'
-          java-version: '11'
-          cache: gradle
-          cache-dependency-path: __tests__/cache/gradle1/*.gradle*
-      - name: Create files to cache
-        # Need to avoid using Gradle daemon to stabilize the save process on Windows
-        # https://github.com/actions/cache/issues/454#issuecomment-840493935
-        run: |
-          gradle downloadDependencies --no-daemon -p __tests__/cache/gradle1
-          if [ ! -d ~/.gradle/caches ]; then
-            echo "::error::The ~/.gradle/caches directory does not exist unexpectedly"
-            exit 1
-          fi
-  gradle1-restore:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-    needs: gradle1-save
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Run setup-java with the cache for gradle
-        uses: ./
-        id: setup-java
-        with:
-          distribution: 'adopt'
-          java-version: '11'
-          cache: gradle
-          cache-dependency-path: __tests__/cache/gradle1/*.gradle*
-      - name: Confirm that ~/.gradle/caches directory has been made
-        run: |
-          if [ ! -d ~/.gradle/caches ]; then
-            echo "::error::The ~/.gradle/caches directory does not exist unexpectedly"
-            exit 1
-          fi
-          ls ~/.gradle/caches/
-  gradle2-restore:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-    needs: gradle1-save
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Run setup-java with the cache for gradle
-        uses: ./
-        id: setup-java
-        with:
-          distribution: 'adopt'
-          java-version: '11'
-          cache: gradle
-          cache-dependency-path: __tests__/cache/gradle2/*.gradle*
-      - name: Confirm that ~/.gradle/caches directory has not been made
-        run: |
-          if [ -d ~/.gradle/caches ]; then
-            echo "::error::The ~/.gradle/caches directory exists unexpectedly"
-            exit 1
-          fi

.github/workflows/e2e-cache.yml

@@ -36,7 +36,7 @@ jobs:
         # Need to avoid using Gradle daemon to stabilize the save process on Windows
         # https://github.com/actions/cache/issues/454#issuecomment-840493935
         run: |
-          gradle downloadDependencies --no-daemon -p __tests__/cache/gradle1
+          gradle downloadDependencies --no-daemon -p __tests__/cache/gradle
           if [ ! -d ~/.gradle/caches ]; then
             echo "::error::The ~/.gradle/caches directory does not exist unexpectedly"
             exit 1
@@ -121,7 +121,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-22.04]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -132,11 +132,16 @@ jobs:
           distribution: 'adopt'
           java-version: '11'
           cache: sbt
+      - name: Setup SBT
+        if: matrix.os == 'macos-13'
+        run: |
+          echo ""Installing SBT...""
+          brew install sbt
       - name: Create files to cache
         run: sbt update
 
       - name: Check files to cache on macos-latest
-        if: matrix.os == 'macos-latest'
+        if: matrix.os == 'macos-13'
         run: |
           if [ ! -d ~/Library/Caches/Coursier ]; then
             echo "::error::The ~/Library/Caches/Coursier directory does not exist unexpectedly"

.github/workflows/e2e-versions.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-2022, ubuntu-22.04]
         distribution: [
             'temurin',
             'adopt',
@@ -37,10 +37,10 @@ jobs:
           - distribution: microsoft
             version: 8
           - distribution: dragonwell
-            os: macos-latest
+            os: macos-13
         include:
           - distribution: oracle
-            os: macos-latest
+            os: macos-13
             version: 17
           - distribution: oracle
             os: windows-latest
@@ -69,7 +69,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         distribution: ['temurin', 'zulu', 'liberica']
         version:
           - '11.0'
@@ -171,7 +171,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         version: ['17-ea', '15.0.0-ea.14']
     steps:
       - name: Checkout
@@ -215,7 +215,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         distribution: ['temurin', 'zulu', 'liberica', 'semeru']
         java-package: ['jre']
         version: ['17.0']
@@ -263,7 +263,7 @@ jobs:
       fail-fast: false
       matrix:
         # x86 is not supported on macOS
-        os: [windows-latest, ubuntu-latest]
+        os: [windows-latest, ubuntu-22.04]
         distribution: ['liberica', 'zulu', 'corretto']
         version: ['11']
     steps:
@@ -311,7 +311,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         distribution: ['temurin', 'zulu', 'liberica', 'microsoft', 'corretto']
     steps:
       - name: Checkout
@@ -335,7 +335,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         distribution: ['adopt', 'adopt-openj9', 'zulu']
     steps:
       - name: Checkout
@@ -359,7 +359,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         distribution: ['adopt', 'zulu', 'liberica']
     steps:
       - name: Checkout

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

@@ -0,0 +1,20 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@v0.0.4

README.md

@@ -41,8 +41,6 @@ This action allows you to work with Java and Scala projects.
 
   - `cache`: Quick [setup caching](#caching-packages-dependencies) for the dependencies managed through one of the predefined package managers. It can be one of "maven", "gradle" or "sbt".
 
-  - `cache-dependency-path`: The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the `cache` option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies.
-
   #### 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.
 
@@ -117,13 +115,10 @@ Currently, the following distributions are supported:
 
 ### Caching packages dependencies
 The action has a built-in functionality for caching and restoring dependencies. It uses [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/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`, `buildSrc/**/Versions.kt`, `buildSrc/**/Dependencies.kt`, `gradle/*.versions.toml`, and `**/versions.properties`
 - maven: `**/pom.xml`
 - sbt: all sbt build definition files `**/*.sbt`, `**/project/build.properties`, `**/project/**.scala`, `**/project/**.sbt`
 
-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](https://github.com/actions/cache/tree/main#outputs).
 
 The cache input is optional, and caching is turned off by default.
@@ -137,9 +132,6 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'gradle'
-    cache-dependency-path: | # optional
-      sub-project/*.gradle*
-      sub-project/**/gradle-wrapper.properties
 - run: ./gradlew build --no-daemon
 ```
 
@@ -152,7 +144,6 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'maven'
-    cache-dependency-path: 'sub-project/pom.xml' # optional
 - name: Build with Maven
   run: mvn -B package --file pom.xml
 ```
@@ -166,29 +157,10 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'sbt'
-    cache-dependency-path: | # optional
-      sub-project/build.sbt
-      sub-project/project/build.properties
 - name: Build with SBT
   run: sbt package
 ```
 
-#### 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](https://github.com/actions/toolkit/tree/main/packages/cache#cache-segment-restore-timeout) 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.
-
-```yaml
-env:
-  SEGMENT_DOWNLOAD_TIMEOUT_MINS: '5'
-steps:
-- uses: actions/checkout@v3
-- uses: actions/setup-java@v3
-  with:
-    distribution: 'temurin'
-    java-version: '17'
-    cache: 'gradle'
-- run: ./gradlew build --no-daemon
-```
-
 ### 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.

__tests__/cache.test.ts

@@ -6,7 +6,6 @@ import * as fs from 'fs';
 import * as os from 'os';
 import * as core from '@actions/core';
 import * as cache from '@actions/cache';
-import * as glob from '@actions/glob';
 
 describe('dependency cache', () => {
   const ORIGINAL_RUNNER_OS = process.env['RUNNER_OS'];
@@ -65,10 +64,6 @@ describe('dependency cache', () => {
       ReturnType<typeof cache.restoreCache>,
       Parameters<typeof cache.restoreCache>
     >;
-    let spyGlobHashFiles: jest.SpyInstance<
-      ReturnType<typeof glob.hashFiles>,
-      Parameters<typeof glob.hashFiles>
-    >;
 
     beforeEach(() => {
       spyCacheRestore = jest
@@ -76,19 +71,18 @@ describe('dependency cache', () => {
         .mockImplementation((paths: string[], primaryKey: string) =>
           Promise.resolve(undefined)
         );
-      spyGlobHashFiles = jest.spyOn(glob, 'hashFiles');
       spyWarning.mockImplementation(() => null);
     });
 
     it('throws error if unsupported package manager specified', () => {
-      return expect(restore('ant', '')).rejects.toThrow(
+      return expect(restore('ant')).rejects.toThrow(
         'unknown package manager specified: ant'
       );
     });
 
     describe('for maven', () => {
       it('throws error if no pom.xml found', async () => {
-        await expect(restore('maven', '')).rejects.toThrow(
+        await expect(restore('maven')).rejects.toThrow(
           `No file in ${projectRoot(
             workspace
           )} matched to [**/pom.xml], make sure you have checked out the target repository`
@@ -97,16 +91,15 @@ describe('dependency cache', () => {
       it('downloads cache', async () => {
         createFile(join(workspace, 'pom.xml'));
 
-        await restore('maven', '');
+        await restore('maven');
         expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith('**/pom.xml');
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('maven cache is not found');
       });
     });
     describe('for gradle', () => {
       it('throws error if no build.gradle found', async () => {
-        await expect(restore('gradle', '')).rejects.toThrow(
+        await expect(restore('gradle')).rejects.toThrow(
           `No file in ${projectRoot(
             workspace
           )} matched to [**/*.gradle*,**/gradle-wrapper.properties,buildSrc/**/Versions.kt,buildSrc/**/Dependencies.kt,gradle/*.versions.toml,**/versions.properties], make sure you have checked out the target repository`
@@ -115,22 +108,16 @@ describe('dependency cache', () => {
       it('downloads cache based on build.gradle', async () => {
         createFile(join(workspace, 'build.gradle'));
 
-        await restore('gradle', '');
+        await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
-        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
       it('downloads cache based on build.gradle.kts', async () => {
         createFile(join(workspace, 'build.gradle.kts'));
 
-        await restore('gradle', '');
+        await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
-        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
@@ -138,30 +125,24 @@ describe('dependency cache', () => {
         createDirectory(join(workspace, 'gradle'));
         createFile(join(workspace, 'gradle', 'libs.versions.toml'));
 
-        await restore('gradle', '');
+        await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
-        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
+    });
     it('downloads cache based on buildSrc/Versions.kt', async () => {
       createDirectory(join(workspace, 'buildSrc'));
       createFile(join(workspace, 'buildSrc', 'Versions.kt'));
 
-        await restore('gradle', '');
+      await restore('gradle');
       expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
-        );
       expect(spyWarning).not.toHaveBeenCalled();
       expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
     });
-    });
     describe('for sbt', () => {
       it('throws error if no build.sbt found', async () => {
-        await expect(restore('sbt', '')).rejects.toThrow(
+        await expect(restore('sbt')).rejects.toThrow(
           `No file in ${projectRoot(
             workspace
           )} matched to [**/*.sbt,**/project/build.properties,**/project/**.scala,**/project/**.sbt], make sure you have checked out the target repository`
@@ -170,11 +151,8 @@ describe('dependency cache', () => {
       it('downloads cache', async () => {
         createFile(join(workspace, 'build.sbt'));
 
-        await restore('sbt', '');
+        await restore('sbt');
         expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '**/*.sbt\n**/project/build.properties\n**/project/**.scala\n**/project/**.sbt'
-        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('sbt cache is not found');
       });
@@ -183,11 +161,11 @@ describe('dependency cache', () => {
         createDirectory(join(workspace, 'project'));
         createFile(join(workspace, 'project/DependenciesV1.scala'));
 
-        await restore('sbt', '');
+        await restore('sbt');
         const firstCall = spySaveState.mock.calls.toString();
 
         spySaveState.mockClear();
-        await restore('sbt', '');
+        await restore('sbt');
         const secondCall = spySaveState.mock.calls.toString();
 
         // Make sure multiple restores produce the same cache
@@ -195,7 +173,7 @@ describe('dependency cache', () => {
 
         spySaveState.mockClear();
         createFile(join(workspace, 'project/DependenciesV2.scala'));
-        await restore('sbt', '');
+        await restore('sbt');
         const thirdCall = spySaveState.mock.calls.toString();
 
         expect(firstCall).not.toBe(thirdCall);
@@ -204,55 +182,11 @@ describe('dependency cache', () => {
     it('downloads cache based on versions.properties', async () => {
       createFile(join(workspace, 'versions.properties'));
 
-      await restore('gradle', '');
+      await restore('gradle');
       expect(spyCacheRestore).toHaveBeenCalled();
-      expect(spyGlobHashFiles).toHaveBeenCalledWith(
-        '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
-      );
       expect(spyWarning).not.toHaveBeenCalled();
       expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
     });
-    describe('cache-dependency-path', () => {
-      it('throws error if no matching dependency file found', async () => {
-        createFile(join(workspace, 'build.gradle.kts'));
-        await expect(
-          restore('gradle', 'sub-project/**/build.gradle.kts')
-        ).rejects.toThrow(
-          `No file in ${projectRoot(
-            workspace
-          )} matched to [sub-project/**/build.gradle.kts], make sure you have checked out the target repository`
-        );
-      });
-      it('downloads cache based on the specified pattern', async () => {
-        createFile(join(workspace, 'build.gradle.kts'));
-        createDirectory(join(workspace, 'sub-project1'));
-        createFile(join(workspace, 'sub-project1', 'build.gradle.kts'));
-        createDirectory(join(workspace, 'sub-project2'));
-        createFile(join(workspace, 'sub-project2', 'build.gradle.kts'));
-
-        await restore('gradle', 'build.gradle.kts');
-        expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith('build.gradle.kts');
-        expect(spyWarning).not.toHaveBeenCalled();
-        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
-
-        await restore('gradle', 'sub-project1/**/*.gradle*\n');
-        expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          'sub-project1/**/*.gradle*'
-        );
-        expect(spyWarning).not.toHaveBeenCalled();
-        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
-
-        await restore('gradle', '*.gradle*\nsub-project2/**/*.gradle*\n');
-        expect(spyCacheRestore).toHaveBeenCalled();
-        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-          '*.gradle*\nsub-project2/**/*.gradle*'
-        );
-        expect(spyWarning).not.toHaveBeenCalled();
-        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
-      });
-    });
   });
   describe('save', () => {
     let spyCacheSave: jest.SpyInstance<

__tests__/cache/gradle2/.gitignore

@@ -1,12 +0,0 @@
-.gradle
-**/build/
-!src/**/build/
-
-# Ignore Gradle GUI config
-gradle-app.setting
-
-# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
-!gradle-wrapper.jar
-
-# Cache of project
-.gradletasknamecache

__tests__/cache/gradle2/build.gradle

@@ -1,17 +0,0 @@
-plugins {
-    id 'java'
-}
-repositories {
-    mavenCentral()
-}
-dependencies {
-    implementation 'org.junit.jupiter:junit-jupiter-api:5.7.2'
-}
-tasks.register('downloadDependencies') {
-    doLast {
-        def total = configurations.compileClasspath.inject (0) { sum, file ->
-            sum + file.length()
-        }
-        println total
-    }
-}

__tests__/data/microsoft.json

@@ -1,41 +1,4 @@
 [
-    {
-      "version": "21.0.0",
-      "stable": true,
-      "release_url": "https://aka.ms/download-jdk",
-      "files": [
-        {
-          "filename": "microsoft-jdk-21.0.0-macos-x64.tar.gz",
-          "arch": "x64",
-          "platform": "darwin",
-          "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-macos-x64.tar.gz"
-        },
-        {
-          "filename": "microsoft-jdk-21.0.0-linux-x64.tar.gz",
-          "arch": "x64",
-          "platform": "linux",
-          "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-linux-x64.tar.gz"
-        },
-        {
-          "filename": "microsoft-jdk-21.0.0-windows-x64.zip",
-          "arch": "x64",
-          "platform": "win32",
-          "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-windows-x64.zip"
-        },
-        {
-          "filename": "microsoft-jdk-21.0.0-macos-aarch64.tar.gz",
-          "arch": "aarch64",
-          "platform": "darwin",
-          "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-macos-aarch64.tar.gz"
-        },
-        {
-          "filename": "microsoft-jdk-21.0.0-linux-aarch64.tar.gz",
-          "arch": "aarch64",
-          "platform": "linux",
-          "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-linux-aarch64.tar.gz"
-        }
-      ]
-    },
     {
         "version": "17.0.7",
         "stable": true,

__tests__/distributors/microsoft-installer.test.ts

@@ -29,11 +29,6 @@ describe('findPackageForDownload', () => {
   });
 
   it.each([
-    [
-      '21.x',
-      '21.0.0',
-      'https://aka.ms/download-jdk/microsoft-jdk-21.0.0-{{OS_TYPE}}-x64.{{ARCHIVE_TYPE}}'
-    ],
     [
       '17.0.1',
       '17.0.1+12.1',

action.yml

@@ -1,6 +1,7 @@
 name: 'Setup Java JDK'
 description: 'Set up a specific version of the Java JDK and add the
    command-line tools to the PATH'
+deprecationMessage: 'setup-java v3 is deprecated and will no longer receive updates. Please migrate to actions/setup-java@v5.'
 author: 'GitHub'
 inputs:
   java-version:
@@ -56,9 +57,6 @@ inputs:
   cache:
     description: 'Name of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt".'
     required: false
-  cache-dependency-path:
-    description: 'The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the `cache` option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies.'
-    required: false
   job-status:
     description: 'Workaround to pass job status to post job step. This variable is not intended for manual setting'
     default: ${{ job.status }}
@@ -81,6 +79,6 @@ outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'
 runs:
-  using: 'node20'
+  using: 'node16'
   main: 'dist/setup/index.js'
   post: 'dist/cleanup/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-java",
-  "version": "4.0.0",
+  "version": "3.4.1",
   "private": true,
   "description": "setup java action",
   "main": "dist/setup/index.js",
@@ -26,36 +26,31 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.0.4",
+    "@actions/cache": "^4.0.3",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.0.4",
-    "@actions/glob": "^0.4.0",
+    "@actions/glob": "^0.2.0",
-    "@actions/http-client": "^2.2.0",
+    "@actions/http-client": "^1.0.11",
     "@actions/io": "^1.0.2",
-    "@actions/tool-cache": "^2.0.1",
+    "@actions/tool-cache": "^1.6.1",
     "semver": "^7.3.4",
     "xmlbuilder2": "^2.4.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.9",
+    "@types/jest": "^27.0.2",
-    "@types/node": "^20.9.3",
+    "@types/node": "^16.11.25",
     "@types/semver": "^7.3.4",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
     "@typescript-eslint/parser": "^5.54.0",
-    "@vercel/ncc": "^0.38.1",
+    "@vercel/ncc": "^0.33.4",
     "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-node": "^11.1.0",
-    "jest": "^29.7.0",
+    "jest": "^27.2.5",
-    "jest-circus": "^29.7.0",
+    "jest-circus": "^27.2.5",
     "prettier": "^2.8.4",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^27.0.5",
-    "typescript": "^5.3.2"
+    "typescript": "^4.2.3"
-  },
+  }
-  "bugs": {
-    "url": "https://github.com/actions/setup-java/issues"
-  },
-  "homepage": "https://github.com/actions/setup-java#readme"
-  
 }

src/cache.ts

@@ -83,34 +83,31 @@ function findPackageManager(id: string): PackageManager {
 /**
  * A function that generates a cache key to use.
  * Format of the generated key will be "${{ platform }}-${{ id }}-${{ fileHash }}"".
+ * If there is no file matched to {@link PackageManager.path}, the generated key ends with a dash (-).
  * @see {@link https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#matching-a-cache-key|spec of cache key}
  */
-async function computeCacheKey(
+async function computeCacheKey(packageManager: PackageManager) {
-  packageManager: PackageManager,
+  const hash = await glob.hashFiles(packageManager.pattern.join('\n'));
-  cacheDependencyPath: string
+  return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${hash}`;
-) {
-  const pattern = cacheDependencyPath
-    ? cacheDependencyPath.trim().split('\n')
-    : packageManager.pattern;
-  const fileHash = await glob.hashFiles(pattern.join('\n'));
-  if (!fileHash) {
-    throw new Error(
-      `No file in ${process.cwd()} matched to [${pattern}], make sure you have checked out the target repository`
-    );
-  }
-  return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${fileHash}`;
 }
 
 /**
  * Restore the dependency cache
  * @param id ID of the package manager, should be "maven" or "gradle"
- * @param cacheDependencyPath The path to a dependency file
  */
-export async function restore(id: string, cacheDependencyPath: string) {
+export async function restore(id: string) {
   const packageManager = findPackageManager(id);
-  const primaryKey = await computeCacheKey(packageManager, cacheDependencyPath);
+  const primaryKey = await computeCacheKey(packageManager);
+
   core.debug(`primary key is ${primaryKey}`);
   core.saveState(STATE_CACHE_PRIMARY_KEY, primaryKey);
+  if (primaryKey.endsWith('-')) {
+    throw new Error(
+      `No file in ${process.cwd()} matched to [${
+        packageManager.pattern
+      }], make sure you have checked out the target repository`
+    );
+  }
 
   // No "restoreKeys" is set, to start with a clear cache after dependency update (see https://github.com/actions/setup-java/issues/269)
   const matchedKey = await cache.restoreCache(packageManager.path, primaryKey);
@@ -149,12 +146,10 @@ export async function save(id: string) {
     await cache.saveCache(packageManager.path, primaryKey);
     core.info(`Cache saved with the key: ${primaryKey}`);
   } catch (error) {
-    const err = error as Error;
+    if (error.name === cache.ReserveCacheError.name) {
-
+      core.info(error.message);
-    if (err.name === cache.ReserveCacheError.name) {
-      core.info(err.message);
     } else {
-      if (isProbablyGradleDaemonProblem(packageManager, err)) {
+      if (isProbablyGradleDaemonProblem(packageManager, error)) {
         core.warning(
           'Failed to save Gradle cache on Windows. If tar.exe reported "Permission denied", try to run Gradle with `--no-daemon` option. Refer to https://github.com/actions/cache/issues/454 for details.'
         );

src/cleanup-java.ts

@@ -13,9 +13,7 @@ async function removePrivateKeyFromKeychain() {
       );
       await gpg.deleteKey(keyFingerprint);
     } catch (error) {
-      core.setFailed(
+      core.setFailed(`Failed to remove private key due to: ${error.message}`);
-        `Failed to remove private key due to: ${(error as Error).message}`
-      );
     }
   }
 }

src/constants.ts

@@ -18,7 +18,6 @@ export const INPUT_DEFAULT_GPG_PRIVATE_KEY = undefined;
 export const INPUT_DEFAULT_GPG_PASSPHRASE = 'GPG_PASSPHRASE';
 
 export const INPUT_CACHE = 'cache';
-export const INPUT_CACHE_DEPENDENCY_PATH = 'cache-dependency-path';
 export const INPUT_JOB_STATUS = 'job-status';
 
 export const STATE_GPG_PRIVATE_KEY_FINGERPRINT = 'gpg-private-key-fingerprint';

src/distributions/dragonwell/installer.ts

@@ -149,9 +149,14 @@ export class DragonwellDistribution extends JavaBase {
 
         // Some version of Dragonwell JDK are numerated with help of non-semver notation (more then 3 digits).
         // Common practice is to transform excess digits to the so-called semver build part, which is prefixed with the plus sign, to be able to operate with them using semver tools.
-        if (jdkVersion.split('.').length > 3) {
+        const jdkVersionNums: string[] = jdkVersion
-          jdkVersion = convertVersionToSemver(jdkVersion);
+          .replace('+', '.')
-        }
+          .split('.');
+        jdkVersion = convertVersionToSemver(
+          `${jdkVersionNums.slice(0, 3).join('.')}.${
+            jdkVersionNums[jdkVersionNums.length - 1]
+          }`
+        );
 
         for (const edition in archMap) {
           eligibleVersions.push({
@@ -206,9 +211,7 @@ export class DragonwellDistribution extends JavaBase {
       return fetchedDragonwellJson;
     } catch (err) {
       core.debug(
-        `Fetching Dragonwell versions info from the primary link: ${primaryUrl} ended up with the error: ${
+        `Fetching Dragonwell versions info from the primary link: ${primaryUrl} ended up with the error: ${err.message}`
-          (err as Error).message
-        }`
       );
       return null;
     }
@@ -234,9 +237,7 @@ export class DragonwellDistribution extends JavaBase {
       return fetchedDragonwellJson;
     } catch (err) {
       core.debug(
-        `Fetching Dragonwell versions info from the backup url: ${backupUrl} ended up with the error: ${
+        `Fetching Dragonwell versions info from the backup url: ${backupUrl} ended up with the error: ${err.message}`
-          (err as Error).message
-        }`
       );
       return null;
     }

src/distributions/microsoft/installer.ts

@@ -13,7 +13,7 @@ import * as core from '@actions/core';
 import * as tc from '@actions/tool-cache';
 import fs from 'fs';
 import path from 'path';
-import {TypedResponse} from '@actions/http-client/lib/interfaces';
+import {ITypedResponse} from '@actions/http-client/interfaces';
 
 export class MicrosoftDistributions extends JavaBase {
   constructor(installerOptions: JavaInstallerOptions) {
@@ -99,7 +99,7 @@ export class MicrosoftDistributions extends JavaBase {
 
     const headers = getGitHubHttpHeaders();
 
-    let response: TypedResponse<tc.IToolRelease[]> | null = null;
+    let response: ITypedResponse<tc.IToolRelease[]> | null = null;
 
     if (core.isDebug()) {
       console.time('Retrieving available versions for Microsoft took'); // eslint-disable-line no-console

src/distributions/microsoft/microsoft-openjdk-versions.json

@@ -1,41 +1,4 @@
 [
-  {
-    "version": "21.0.0",
-    "stable": true,
-    "release_url": "https://aka.ms/download-jdk",
-    "files": [
-      {
-        "filename": "microsoft-jdk-21.0.0-macos-x64.tar.gz",
-        "arch": "x64",
-        "platform": "darwin",
-        "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-macos-x64.tar.gz"
-      },
-      {
-        "filename": "microsoft-jdk-21.0.0-linux-x64.tar.gz",
-        "arch": "x64",
-        "platform": "linux",
-        "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-linux-x64.tar.gz"
-      },
-      {
-        "filename": "microsoft-jdk-21.0.0-windows-x64.zip",
-        "arch": "x64",
-        "platform": "win32",
-        "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-windows-x64.zip"
-      },
-      {
-        "filename": "microsoft-jdk-21.0.0-macos-aarch64.tar.gz",
-        "arch": "aarch64",
-        "platform": "darwin",
-        "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-macos-aarch64.tar.gz"
-      },
-      {
-        "filename": "microsoft-jdk-21.0.0-linux-aarch64.tar.gz",
-        "arch": "aarch64",
-        "platform": "linux",
-        "download_url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.0-linux-aarch64.tar.gz"
-      }
-    ]
-  },
     {
         "version": "17.0.7",
         "stable": true,

src/setup-java.ts

@@ -13,8 +13,13 @@ import * as path from 'path';
 import {getJavaDistribution} from './distributions/distribution-factory';
 import {JavaInstallerOptions} from './distributions/base-models';
 
+const DEPRECATION_WARNING =
+  'setup-java v3 is deprecated and will no longer receive updates. Please migrate to actions/setup-java@v5.';
+
 async function run() {
   try {
+    core.warning(DEPRECATION_WARNING);
+
     const versions = core.getMultilineInput(constants.INPUT_JAVA_VERSION);
     const distributionName = core.getInput(constants.INPUT_DISTRIBUTION, {
       required: true
@@ -24,9 +29,6 @@ async function run() {
     const packageType = core.getInput(constants.INPUT_JAVA_PACKAGE);
     const jdkFile = core.getInput(constants.INPUT_JDK_FILE);
     const cache = core.getInput(constants.INPUT_CACHE);
-    const cacheDependencyPath = core.getInput(
-      constants.INPUT_CACHE_DEPENDENCY_PATH
-    );
     const checkLatest = getBooleanInput(constants.INPUT_CHECK_LATEST, false);
     let toolchainIds = core.getMultilineInput(constants.INPUT_MVN_TOOLCHAIN_ID);
 
@@ -76,10 +78,10 @@ async function run() {
 
     await auth.configureAuthentication();
     if (cache && isCacheFeatureAvailable()) {
-      await restore(cache, cacheDependencyPath);
+      await restore(cache);
     }
   } catch (error) {
-    core.setFailed((error as Error).message);
+    core.setFailed(error.message);
   }
 }