Deprecate setup-java v2 (#1196)

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

.github/workflows/build.yml

@@ -20,11 +20,10 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
       - uses: actions/checkout@v2
-      - name: Setup Node.JS 16
+      - name: Setup Node.JS 12
         uses: actions/setup-node@v2
         with:
-          node-version: 16.x
-          cache: npm
+          node-version: 12.x
       - run: npm ci
       - run: npm run build
       - run: npm run format-check

.github/workflows/check-dist.yml

@@ -23,10 +23,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set Node.js 16.x
+      - name: Set Node.js 12.x
         uses: actions/setup-node@v1
         with:
-          node-version: 16.x
+          node-version: 12.x
 
       - name: Install dependencies
         run: npm ci

.github/workflows/licensed.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install licensed
         run: |
           cd $RUNNER_TEMP
-          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.4.4/licensed-3.4.4-linux-x64.tar.gz
+          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.3.1/licensed-3.3.1-linux-x64.tar.gz
           sudo tar -xzf licensed.tar.gz
           sudo mv licensed /usr/local/bin/licensed
       - run: licensed status

README.md

@@ -66,11 +66,7 @@ Currently, the following distributions are supported:
 **NOTE:** Adopt OpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from `adopt` to `temurin` to keep receiving software and security updates. See more details in the [Good-bye AdoptOpenJDK post](https://blog.adoptopenjdk.net/2021/08/goodbye-adoptopenjdk-hello-adoptium/).
 
 ### Caching packages dependencies
-The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle and maven. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files:
-- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`
-- maven: `**/pom.xml`
-
-The cache input is optional, and caching is turned off by default.
+The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle and maven. The cache input is optional, and caching is turned off by default.
 
 #### Caching gradle dependencies
 ```yaml

__tests__/util.test.ts

@@ -1,9 +1,4 @@
-import * as cache from '@actions/cache';
-import * as core from '@actions/core';
-import { isVersionSatisfies, isCacheFeatureAvailable } from '../src/util';
-
-jest.mock('@actions/cache');
-jest.mock('@actions/core');
+import { isVersionSatisfies } from '../src/util';
 
 describe('isVersionSatisfies', () => {
   it.each([
@@ -25,38 +20,3 @@ describe('isVersionSatisfies', () => {
     expect(actual).toBe(expected);
   });
 });
-
-describe('isCacheFeatureAvailable', () => {
-  it('isCacheFeatureAvailable disabled on GHES', () => {
-    jest.spyOn(cache, 'isFeatureAvailable').mockImplementation(() => false);
-    try {
-      process.env['GITHUB_SERVER_URL'] = 'http://example.com';
-      isCacheFeatureAvailable();
-    } catch (error) {
-      expect(error).toHaveProperty(
-        'message',
-        'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'
-      );
-    } finally {
-      delete process.env['GITHUB_SERVER_URL'];
-    }
-  });
-
-  it('isCacheFeatureAvailable disabled on dotcom', () => {
-    jest.spyOn(cache, 'isFeatureAvailable').mockImplementation(() => false);
-    const infoMock = jest.spyOn(core, 'warning');
-    const message = 'The runner was not able to contact the cache service. Caching will be skipped';
-    try {
-      process.env['GITHUB_SERVER_URL'] = 'http://github.com';
-      expect(isCacheFeatureAvailable()).toBe(false);
-      expect(infoMock).toHaveBeenCalledWith(message);
-    } finally {
-      delete process.env['GITHUB_SERVER_URL'];
-    }
-  });
-
-  it('isCacheFeatureAvailable is enabled', () => {
-    jest.spyOn(cache, 'isFeatureAvailable').mockImplementation(() => true);
-    expect(isCacheFeatureAvailable()).toBe(true);
-  });
-});

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 v2 is deprecated and will no longer receive updates. Please migrate to actions/setup-java@v5.'
 author: 'GitHub'
 inputs:
   java-version:
@@ -67,6 +68,6 @@ outputs:
   path:
     description: 'Path to where the java environment has been installed (same as $JAVA_HOME)'
 runs:
-  using: 'node16'
+  using: 'node12'
   main: 'dist/setup/index.js'
   post: 'dist/cleanup/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-java",
-  "version": "3.1.0",
+  "version": "2.0.0",
   "private": true,
   "description": "setup java action",
   "main": "dist/setup/index.js",
@@ -24,8 +24,8 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^2.0.0",
-    "@actions/core": "^1.2.6",
+    "@actions/cache": "^1.0.8",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.0.4",
     "@actions/glob": "^0.2.0",
     "@actions/http-client": "^1.0.11",
@@ -36,7 +36,7 @@
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
-    "@types/node": "^16.11.25",
+    "@types/node": "^12.19.13",
     "@types/semver": "^7.3.4",
     "@zeit/ncc": "^0.20.5",
     "jest": "^27.2.5",
@@ -44,5 +44,11 @@
     "prettier": "^1.19.1",
     "ts-jest": "^27.0.5",
     "typescript": "^4.2.3"
+  },
+  "husky": {
+    "skipCI": true,
+    "hooks": {
+      "pre-commit": "npm run build && npm run format"
+    }
   }
 }

src/setup-java.ts

@@ -1,14 +1,19 @@
 import * as core from '@actions/core';
 import * as auth from './auth';
-import { getBooleanInput, isCacheFeatureAvailable } from './util';
+import { getBooleanInput } from './util';
 import * as constants from './constants';
 import { restore } from './cache';
 import * as path from 'path';
 import { getJavaDistribution } from './distributions/distribution-factory';
 import { JavaInstallerOptions } from './distributions/base-models';
 
+const DEPRECATION_WARNING =
+  'setup-java v2 is deprecated and will no longer receive updates. Please migrate to actions/setup-java@v5.';
+
 async function run() {
   try {
+    core.warning(DEPRECATION_WARNING);
+
     const version = core.getInput(constants.INPUT_JAVA_VERSION, { required: true });
     const distributionName = core.getInput(constants.INPUT_DISTRIBUTION, { required: true });
     const architecture = core.getInput(constants.INPUT_ARCHITECTURE);
@@ -42,7 +47,7 @@ async function run() {
     core.info(`##[add-matcher]${path.join(matchersPath, 'java.json')}`);
 
     await auth.configureAuthentication();
-    if (cache && isCacheFeatureAvailable()) {
+    if (cache) {
       await restore(cache);
     }
   } catch (error) {

src/util.ts

@@ -2,7 +2,6 @@ import os from 'os';
 import path from 'path';
 import * as fs from 'fs';
 import * as semver from 'semver';
-import * as cache from '@actions/cache';
 import * as core from '@actions/core';
 
 import * as tc from '@actions/tool-cache';
@@ -78,24 +77,3 @@ export function isJobStatusSuccess() {
 
   return jobStatus === 'success';
 }
-
-export function isGhes(): boolean {
-  const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
-  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
-}
-
-export function isCacheFeatureAvailable(): boolean {
-  if (!cache.isFeatureAvailable()) {
-    if (isGhes()) {
-      throw new Error(
-        'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'
-      );
-    } else {
-      core.warning('The runner was not able to contact the cache service. Caching will be skipped');
-    }
-
-    return false;
-  }
-
-  return true;
-}