Add support for arm64 Windows (#927)

* add support for arm64 Windows

* revert 7z to exe

* add comment

---------

Co-authored-by: aparnajyothi-y <147696841+aparnajyothi-y@users.noreply.github.com>

.github/workflows/e2e-cache.yml

@@ -135,44 +135,6 @@ jobs:
         run: __tests__/verify-node.sh "${{ matrix.node-version }}"
         shell: bash
 
-  node-yarn4-corepack-dependencies-caching:
-    name: Test yarn 4 (Node ${{ matrix.node-version}}, ${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
-    env:
-      YARN_ENABLE_IMMUTABLE_INSTALLS: false
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [18, 20]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Update yarn
-        run: yarn set version 4.1.0
-      - name: Yarn version
-        run: yarn --version
-      - name: Generate simple .yarnrc.yml
-        run: |
-          echo "nodeLinker: node-modules" >> .yarnrc.yml
-      - name: Generate yarn file
-        run: yarn install
-      - name: Remove dependencies
-        shell: pwsh
-        run: Remove-Item node_modules -Force -Recurse
-      - name: Clean global cache
-        run: yarn cache clean --all
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-          corepack: true
-      - name: Install dependencies
-        run: yarn install
-      - name: Verify node and yarn
-        run: __tests__/verify-node.sh "${{ matrix.node-version }}"
-        shell: bash
-
   yarn-subprojects:
     name: Test yarn subprojects
     strategy:

README.md

@@ -26,22 +26,22 @@ See [action.yml](action.yml)
     node-version: ''
 
     # File containing the version Spec of the version to use.  Examples: package.json, .nvmrc, .node-version, .tool-versions.
-    # If node-version and node-version-file are both provided the action will use version from node-version.
+    # If node-version and node-version-file are both provided the action will use version from node-version. 
     node-version-file: ''
 
-    # Set this option if you want the action to check for the latest available version
+    # Set this option if you want the action to check for the latest available version 
     # that satisfies the version spec.
-    # It will only get affect for lts Nodejs versions (12.x, >=10.15.0, lts/Hydrogen).
+    # It will only get affect for lts Nodejs versions (12.x, >=10.15.0, lts/Hydrogen). 
     # Default: false
     check-latest: false
 
     # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.
-    # Default: ''. The action use system architecture by default
+    # Default: ''. The action use system architecture by default 
     architecture: ''
 
-    # Used to pull node distributions from https://github.com/actions/node-versions.
-    # Since there's a default, this is typically not supplied by the user.
-    # When running this action on github.com, the default value is sufficient.
+    # Used to pull node distributions from https://github.com/actions/node-versions. 
+    # Since there's a default, this is typically not supplied by the user. 
+    # When running this action on github.com, the default value is sufficient. 
     # When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
     #
     # We recommend using a service account with the least permissions necessary. Also
@@ -57,18 +57,18 @@ See [action.yml](action.yml)
     # Default: ''
     cache: ''
 
-    # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc.
-    # It will generate hash from the target file for primary key. It works only If cache is specified.
+    # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. 
+    # It will generate hash from the target file for primary key. It works only If cache is specified.  
     # Supports wildcards or a list of file names for caching multiple dependencies.
     # Default: ''
     cache-dependency-path: ''
 
-    # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file,
+    # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, 
     # and set up auth to read in from env.NODE_AUTH_TOKEN.
     # Default: ''
     registry-url: ''
 
-    # Optional scope for authenticating against scoped registries.
+    # Optional scope for authenticating against scoped registries. 
     # Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).
     # Default: ''
     scope: ''
@@ -203,7 +203,6 @@ If the runner is not able to access github.com, any Nodejs versions requested du
  - [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm)
  - [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn)
  - [Using private packages](docs/advanced-usage.md#use-private-packages)
- - [Enabling Corepack](docs/advanced-usage.md#enabling-corepack)
 
 ## License
 

__tests__/main.test.ts

@@ -2,6 +2,7 @@ import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import * as tc from '@actions/tool-cache';
 import * as cache from '@actions/cache';
+import * as io from '@actions/io';
 
 import fs from 'fs';
 import path from 'path';
@@ -11,7 +12,6 @@ import each from 'jest-each';
 
 import * as main from '../src/main';
 import * as util from '../src/util';
-import * as cacheUtil from '../src/cache-utils';
 import OfficialBuilds from '../src/distributions/official_builds/official_builds';
 
 describe('main tests', () => {
@@ -25,8 +25,11 @@ describe('main tests', () => {
   let startGroupSpy: jest.SpyInstance;
   let endGroupSpy: jest.SpyInstance;
 
+  let whichSpy: jest.SpyInstance;
+
+  let existsSpy: jest.SpyInstance;
+
   let getExecOutputSpy: jest.SpyInstance;
-  let getCommandOutputSpy: jest.SpyInstance;
 
   let getNodeVersionFromFileSpy: jest.SpyInstance;
   let cnSpy: jest.SpyInstance;
@@ -57,8 +60,9 @@ describe('main tests', () => {
     inSpy = jest.spyOn(core, 'getInput');
     inSpy.mockImplementation(name => inputs[name]);
 
+    whichSpy = jest.spyOn(io, 'which');
+
     getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
-    getCommandOutputSpy = jest.spyOn(cacheUtil, 'getCommandOutput');
 
     findSpy = jest.spyOn(tc, 'find');
 
@@ -143,6 +147,10 @@ describe('main tests', () => {
         return {stdout: obj[command], stderr: '', exitCode: 0};
       });
 
+      whichSpy.mockImplementation(cmd => {
+        return `some/${cmd}/path`;
+      });
+
       await util.printEnvDetailsAndSetOutput();
 
       expect(setOutputSpy).toHaveBeenCalledWith('node-version', obj['node']);
@@ -272,38 +280,4 @@ describe('main tests', () => {
       );
     });
   });
-
-  describe('corepack flag', () => {
-    it('should not enable corepack when no input', async () => {
-      inputs['corepack'] = '';
-      await main.run();
-      expect(getCommandOutputSpy).not.toHaveBeenCalledWith(expect.stringContaining('corepack'));
-    });
-
-    it('should not enable corepack when input is "false"', async () => {
-      inputs['corepack'] = 'false';
-      await main.run();
-      expect(getCommandOutputSpy).not.toHaveBeenCalledWith(expect.stringContaining('corepack'));
-    });
-
-    it('should enable corepack when input is "true"', async () => {
-      inputs['corepack'] = 'true';
-      await main.run();
-      expect(getCommandOutputSpy).toHaveBeenCalledWith('corepack enable');
-    });
-
-    it('should enable corepack with a single package manager', async () => {
-      inputs['corepack'] = 'npm';
-      await main.run();
-      expect(getCommandOutputSpy).toHaveBeenCalledWith('corepack enable npm');
-    });
-
-    it('should enable corepack with multiple package managers', async () => {
-      inputs['corepack'] = 'npm yarn';
-      await main.run();
-      expect(getCommandOutputSpy).toHaveBeenCalledWith(
-        'corepack enable npm yarn'
-      );
-    });
-  });
 });

__tests__/official-installer.test.ts

@@ -248,6 +248,9 @@ describe('setup-node', () => {
     const toolPath = path.normalize('/cache/node/12.16.2/x64');
     exSpy.mockImplementation(async () => '/some/other/temp/path');
     cacheSpy.mockImplementation(async () => toolPath);
+    whichSpy.mockImplementation(cmd => {
+      return `some/${cmd}/path`;
+    });
 
     await main.run();
 

action.yml

@@ -25,13 +25,10 @@ inputs:
     description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.'
   cache-dependency-path:
     description: 'Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.'
-  corepack:
-    description: 'Used to specify whether to enable Corepack. Set to true to enable all package managers or set it to one or more package manager names separated by a space. Supported package manager names: npm, yarn, pnpm.'
-    default: 'false'
 # TODO: add input to control forcing to pull from cloud or dist.
 #       escape valve for someone having issues or needing the absolute latest which isn't cached yet
 outputs:
-  cache-hit:
+  cache-hit: 
     description: 'A boolean value to indicate if a cache was hit.'
   node-version:
     description: 'The installed node version.'

dist/cache-save/index.js

@@ -83333,12 +83333,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.enableCorepack = exports.unique = exports.printEnvDetailsAndSetOutput = exports.getNodeVersionFromFile = void 0;
+exports.unique = exports.printEnvDetailsAndSetOutput = exports.getNodeVersionFromFile = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const exec = __importStar(__nccwpck_require__(1514));
+const io = __importStar(__nccwpck_require__(7436));
 const fs_1 = __importDefault(__nccwpck_require__(7147));
 const path_1 = __importDefault(__nccwpck_require__(1017));
-const cache_utils_1 = __nccwpck_require__(1678);
 function getNodeVersionFromFile(versionFilePath) {
     var _a, _b, _c, _d, _e;
     if (!fs_1.default.existsSync(versionFilePath)) {
@@ -83388,7 +83388,8 @@ function printEnvDetailsAndSetOutput() {
     return __awaiter(this, void 0, void 0, function* () {
         core.startGroup('Environment details');
         const promises = ['node', 'npm', 'yarn'].map((tool) => __awaiter(this, void 0, void 0, function* () {
-            const output = yield getToolVersion(tool, ['--version']);
+            const pathTool = yield io.which(tool, false);
+            const output = pathTool ? yield getToolVersion(tool, ['--version']) : '';
             return { tool, output };
         }));
         const tools = yield Promise.all(promises);
@@ -83430,19 +83431,6 @@ const unique = () => {
     };
 };
 exports.unique = unique;
-function enableCorepack(input) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (input.length && input !== 'false') {
-            const corepackArgs = ['enable'];
-            if (input !== 'true') {
-                const packageManagers = input.split(' ');
-                corepackArgs.push(...packageManagers);
-            }
-            yield (0, cache_utils_1.getCommandOutput)(`corepack ${corepackArgs.join(' ')}`);
-        }
-    });
-}
-exports.enableCorepack = enableCorepack;
 
 
 /***/ }),

dist/setup/index.js

@@ -93110,7 +93110,11 @@ class BaseDistribution {
         const fileName = this.osPlat == 'win32'
             ? `node-v${version}-win-${osArch}`
             : `node-v${version}-${this.osPlat}-${osArch}`;
-        const urlFileName = this.osPlat == 'win32' ? `${fileName}.7z` : `${fileName}.tar.gz`;
+        const urlFileName = this.osPlat == 'win32'
+            ? this.nodeInfo.arch === 'arm64'
+                ? `${fileName}.zip`
+                : `${fileName}.7z`
+            : `${fileName}.tar.gz`;
         const initialUrl = this.getDistributionUrl();
         const url = `${initialUrl}/v${version}/${urlFileName}`;
         return {
@@ -93194,10 +93198,23 @@ class BaseDistribution {
             let extPath;
             info = info || {}; // satisfy compiler, never null when reaches here
             if (this.osPlat == 'win32') {
-                const _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe');
-                extPath = yield tc.extract7z(downloadPath, undefined, _7zPath);
+                const extension = this.nodeInfo.arch === 'arm64' ? '.zip' : '.7z';
+                // Rename archive to add extension because after downloading
+                // archive does not contain extension type and it leads to some issues
+                // on Windows runners without PowerShell Core.
+                //
+                // For default PowerShell Windows it should contain extension type to unpack it.
+                if (extension === '.zip') {
+                    const renamedArchive = `${downloadPath}.zip`;
+                    fs_1.default.renameSync(downloadPath, renamedArchive);
+                    extPath = yield tc.extractZip(renamedArchive);
+                }
+                else {
+                    const _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe');
+                    extPath = yield tc.extract7z(downloadPath, undefined, _7zPath);
+                }
                 // 7z extracts to folder matching file name
-                const nestedPath = path.join(extPath, path.basename(info.fileName, '.7z'));
+                const nestedPath = path.join(extPath, path.basename(info.fileName, extension));
                 if (fs_1.default.existsSync(nestedPath)) {
                     extPath = nestedPath;
                 }
@@ -93229,7 +93246,12 @@ class BaseDistribution {
                 dataFileName = `osx-${osArch}-tar`;
                 break;
             case 'win32':
-                dataFileName = `win-${osArch}-exe`;
+                if (this.nodeInfo.arch === 'arm64') {
+                    dataFileName = `win-${osArch}-zip`;
+                }
+                else {
+                    dataFileName = `win-${osArch}-exe`;
+                }
                 break;
             default:
                 throw new Error(`Unexpected OS '${this.osPlat}'`);
@@ -93697,8 +93719,6 @@ function run() {
             if (registryUrl) {
                 auth.configAuthentication(registryUrl, alwaysAuth);
             }
-            const corepack = core.getInput('corepack') || 'false';
-            yield (0, util_1.enableCorepack)(corepack);
             if (cache && (0, cache_utils_1.isCacheFeatureAvailable)()) {
                 core.saveState(constants_1.State.CachePackageManager, cache);
                 const cacheDependencyPath = core.getInput('cache-dependency-path');
@@ -93782,12 +93802,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.enableCorepack = exports.unique = exports.printEnvDetailsAndSetOutput = exports.getNodeVersionFromFile = void 0;
+exports.unique = exports.printEnvDetailsAndSetOutput = exports.getNodeVersionFromFile = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const exec = __importStar(__nccwpck_require__(1514));
+const io = __importStar(__nccwpck_require__(7436));
 const fs_1 = __importDefault(__nccwpck_require__(7147));
 const path_1 = __importDefault(__nccwpck_require__(1017));
-const cache_utils_1 = __nccwpck_require__(1678);
 function getNodeVersionFromFile(versionFilePath) {
     var _a, _b, _c, _d, _e;
     if (!fs_1.default.existsSync(versionFilePath)) {
@@ -93837,7 +93857,8 @@ function printEnvDetailsAndSetOutput() {
     return __awaiter(this, void 0, void 0, function* () {
         core.startGroup('Environment details');
         const promises = ['node', 'npm', 'yarn'].map((tool) => __awaiter(this, void 0, void 0, function* () {
-            const output = yield getToolVersion(tool, ['--version']);
+            const pathTool = yield io.which(tool, false);
+            const output = pathTool ? yield getToolVersion(tool, ['--version']) : '';
             return { tool, output };
         }));
         const tools = yield Promise.all(promises);
@@ -93879,19 +93900,6 @@ const unique = () => {
     };
 };
 exports.unique = unique;
-function enableCorepack(input) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (input.length && input !== 'false') {
-            const corepackArgs = ['enable'];
-            if (input !== 'true') {
-                const packageManagers = input.split(' ');
-                corepackArgs.push(...packageManagers);
-            }
-            yield (0, cache_utils_1.getCommandOutput)(`corepack ${corepackArgs.join(' ')}`);
-        }
-    });
-}
-exports.enableCorepack = enableCorepack;
 
 
 /***/ }),

docs/advanced-usage.md

@@ -159,7 +159,7 @@ jobs:
 
 ## Nightly versions
 
-You can specify a nightly version to download it from https://nodejs.org/download/nightly.
+You can specify a nightly version to download it from https://nodejs.org/download/nightly. 
 
 ### Install the nightly build for a major version
 
@@ -267,7 +267,7 @@ steps:
 - run: pnpm test
 ```
 
-> **Note**: By default `--frozen-lockfile` option is passed starting from pnpm `6.10.x`. It will be automatically added if you run it on [CI](https://pnpm.io/cli/install#--frozen-lockfile).
+> **Note**: By default `--frozen-lockfile` option is passed starting from pnpm `6.10.x`. It will be automatically added if you run it on [CI](https://pnpm.io/cli/install#--frozen-lockfile). 
 > If the `pnpm-lock.yaml` file changes then pass `--frozen-lockfile` option.
 
 
@@ -418,30 +418,3 @@ Please refer to the [Ensuring workflow access to your package - Configuring a pa
 
 ### always-auth input
 The always-auth input sets `always-auth=true` in .npmrc file. With this option set [npm](https://docs.npmjs.com/cli/v6/using-npm/config#always-auth)/yarn sends the authentication credentials when making a request to the registries.
-
-## Enabling Corepack
-You can enable [Corepack](https://github.com/nodejs/corepack) by using the `corepack` input. You can then use `pnpm` and `yarn` commands in your project.
-
-```yaml
-steps:
-- uses: actions/checkout@v4
-- uses: actions/setup-node@v4
-  with:
-    node-version: '18.x'
-    corepack: true
-- name: Install dependencies
-  run: yarn install --immutable
-```
-
-You can also pass package manager names separated by a space to enable corepack for specific package managers only.
-
-```yaml
-steps:
-- uses: actions/checkout@v4
-- uses: actions/setup-node@v4
-  with:
-    node-version: '18.x'
-    corepack: yarn pnpm
-- name: Install dependencies
-  run: yarn install --immutable
-```

src/distributions/base-distribution.ts

@@ -112,7 +112,11 @@ export default abstract class BaseDistribution {
         ? `node-v${version}-win-${osArch}`
         : `node-v${version}-${this.osPlat}-${osArch}`;
     const urlFileName: string =
-      this.osPlat == 'win32' ? `${fileName}.7z` : `${fileName}.tar.gz`;
+      this.osPlat == 'win32'
+        ? this.nodeInfo.arch === 'arm64'
+          ? `${fileName}.zip`
+          : `${fileName}.7z`
+        : `${fileName}.tar.gz`;
     const initialUrl = this.getDistributionUrl();
     const url = `${initialUrl}/v${version}/${urlFileName}`;
 
@@ -215,12 +219,24 @@ export default abstract class BaseDistribution {
     let extPath: string;
     info = info || ({} as INodeVersionInfo); // satisfy compiler, never null when reaches here
     if (this.osPlat == 'win32') {
-      const _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe');
-      extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
+      const extension = this.nodeInfo.arch === 'arm64' ? '.zip' : '.7z';
+      // Rename archive to add extension because after downloading
+      // archive does not contain extension type and it leads to some issues
+      // on Windows runners without PowerShell Core.
+      //
+      // For default PowerShell Windows it should contain extension type to unpack it.
+      if (extension === '.zip') {
+        const renamedArchive = `${downloadPath}.zip`;
+        fs.renameSync(downloadPath, renamedArchive);
+        extPath = await tc.extractZip(renamedArchive);
+      } else {
+        const _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe');
+        extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
+      }
       // 7z extracts to folder matching file name
       const nestedPath = path.join(
         extPath,
-        path.basename(info.fileName, '.7z')
+        path.basename(info.fileName, extension)
       );
       if (fs.existsSync(nestedPath)) {
         extPath = nestedPath;
@@ -260,7 +276,11 @@ export default abstract class BaseDistribution {
         dataFileName = `osx-${osArch}-tar`;
         break;
       case 'win32':
-        dataFileName = `win-${osArch}-exe`;
+        if (this.nodeInfo.arch === 'arm64') {
+          dataFileName = `win-${osArch}-zip`;
+        } else {
+          dataFileName = `win-${osArch}-exe`;
+        }
         break;
       default:
         throw new Error(`Unexpected OS '${this.osPlat}'`);

src/main.ts

@@ -7,11 +7,7 @@ import * as path from 'path';
 import {restoreCache} from './cache-restore';
 import {isCacheFeatureAvailable} from './cache-utils';
 import {getNodejsDistribution} from './distributions/installer-factory';
-import {
-  getNodeVersionFromFile,
-  printEnvDetailsAndSetOutput,
-  enableCorepack
-} from './util';
+import {getNodeVersionFromFile, printEnvDetailsAndSetOutput} from './util';
 import {State} from './constants';
 
 export async function run() {
@@ -63,9 +59,6 @@ export async function run() {
       auth.configAuthentication(registryUrl, alwaysAuth);
     }
 
-    const corepack = core.getInput('corepack') || 'false';
-    await enableCorepack(corepack);
-
     if (cache && isCacheFeatureAvailable()) {
       core.saveState(State.CachePackageManager, cache);
       const cacheDependencyPath = core.getInput('cache-dependency-path');

src/util.ts

@@ -1,9 +1,9 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
+import * as io from '@actions/io';
 
 import fs from 'fs';
 import path from 'path';
-import {getCommandOutput} from './cache-utils';
 
 export function getNodeVersionFromFile(versionFilePath: string): string | null {
   if (!fs.existsSync(versionFilePath)) {
@@ -62,9 +62,9 @@ export function getNodeVersionFromFile(versionFilePath: string): string | null {
 
 export async function printEnvDetailsAndSetOutput() {
   core.startGroup('Environment details');
-
   const promises = ['node', 'npm', 'yarn'].map(async tool => {
-    const output = await getToolVersion(tool, ['--version']);
+    const pathTool = await io.which(tool, false);
+    const output = pathTool ? await getToolVersion(tool, ['--version']) : '';
 
     return {tool, output};
   });
@@ -106,14 +106,3 @@ export const unique = () => {
     return true;
   };
 };
-
-export async function enableCorepack(input: string): Promise<void> {
-  if (input.length && input !== 'false') {
-    const corepackArgs = ['enable'];
-    if (input !== 'true') {
-      const packageManagers = input.split(' ');
-      corepackArgs.push(...packageManagers);
-    }
-    await getCommandOutput(`corepack ${corepackArgs.join(' ')}`);
-  }
-}