Merge pull request #373 from ganta/add-support-for-asdf-format-as-node-version-file

Add support for asdf format as Node.js version file
README.md: Encourage testing on current Node.js (#533 )
2022-07-11 13:48:55 +02:00 · 2022-07-07 14:53:32 +02:00 · 2022-07-04 23:29:56 +02:00 · 2022-07-04 14:45:20 +02:00 · 2022-07-04 10:38:01 +02:00 · 2022-07-01 01:30:18 +02:00
15 changed files with 2183 additions and 2727 deletions
@@ -92,12 +92,13 @@ jobs:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version-file: [.nvmrc, .tool-versions]
    steps:
      - uses: actions/checkout@v3
      - name: Setup node from node version file
        uses: ./
        with:
-          node-version-file: '__tests__/data/.nvmrc'
+          node-version-file: '__tests__/data/${{ matrix.node-version-file }}'
      - name: Verify node
        run: __tests__/verify-node.sh 14

@@ -1,6 +1,6 @@
 ---
 name: "@actions/http-client"
-version: 2.0.1
+version: 1.0.11
 type: npm
 summary: Actions Http Client
 homepage: https://github.com/actions/http-client#readme
@@ -0,0 +1,32 @@
+---
+name: "@actions/http-client"
+version: 2.0.1
+type: npm
+summary: Actions Http Client
+homepage: https://github.com/actions/toolkit/tree/main/packages/http-client
+license: mit
+licenses:
+- sources: LICENSE
+  text: |
+    Actions Http Client for Node.js
+
+    Copyright (c) GitHub, Inc.
+
+    All rights reserved.
+
+    MIT License
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+    associated documentation files (the "Software"), to deal in the Software without restriction,
+    including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+    subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+    LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+    NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+notices: []
@@ -22,7 +22,7 @@ steps:
 - uses: actions/checkout@v3
 - uses: actions/setup-node@v3
  with:
-    node-version: 14
+    node-version: 16
 - run: npm ci
 - run: npm test
 ```
@@ -39,8 +39,8 @@ The `node-version` input supports the Semantic Versioning Specification, for mor

 Examples:

- - Major versions: `12`, `14`, `16`
- - More specific versions: `10.15`, `14.2.0`, `16.3.0`
+ - Major versions: `14`, `16`, `18`
+ - More specific versions: `10.15`, `16.15.1` , `18.4.0`
 - NVM LTS syntax: `lts/erbium`, `lts/fermium`, `lts/*`, `lts/-n`
 - Latest release: `*` or `latest`/`current`/`node`

@@ -58,7 +58,7 @@ It's **always** recommended to commit the lockfile of your package manager for s

 The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under the hood for caching global packages data but requires less configuration settings. Supported package managers are `npm`, `yarn`, `pnpm` (v6.10+). The `cache` input is optional, and caching is turned off by default.

-The action defaults to search for the dependency file (`package-lock.json` or `yarn.lock`) in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` for cases when multiple dependency files are used, or they are located in different subdirectories.
+The action defaults to search for the dependency file (`package-lock.json`, `npm-shrinkwrap.json` or `yarn.lock`) in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` for cases when multiple dependency files are used, or they are located in different subdirectories.

 **Note:** The action does not cache `node_modules`

@@ -71,7 +71,7 @@ steps:
 - uses: actions/checkout@v3
 - uses: actions/setup-node@v3
  with:
-    node-version: 14
+    node-version: 16
    cache: 'npm'
 - run: npm ci
 - run: npm test
@@ -84,7 +84,7 @@ steps:
 - uses: actions/checkout@v3
 - uses: actions/setup-node@v3
  with:
-    node-version: 14
+    node-version: 16
    cache: 'npm'
    cache-dependency-path: subdir/package-lock.json
 - run: npm ci
@@ -99,7 +99,7 @@ jobs:
    runs-on: ubuntu-latest
    strategy:
      matrix:
-        node: [ 12, 14, 16 ]
+        node: [ 14, 16, 18 ]
    name: Node ${{ matrix.node }} sample
    steps:
      - uses: actions/checkout@v3
@@ -0,0 +1 @@
+nodejs 14.0.0
@@ -1,12 +1,14 @@
 import * as core from '@actions/core';
 import * as io from '@actions/io';
 import * as tc from '@actions/tool-cache';
+import * as exec from '@actions/exec';
 import * as im from '../src/installer';
 import * as cache from '@actions/cache';
 import fs from 'fs';
 import cp from 'child_process';
 import osm = require('os');
 import path from 'path';
+import each from 'jest-each';
 import * as main from '../src/main';
 import * as auth from '../src/authutil';

@@ -38,6 +40,7 @@ describe('setup-node', () => {
  let authSpy: jest.SpyInstance;
  let parseNodeVersionSpy: jest.SpyInstance;
  let isCacheActionAvailable: jest.SpyInstance;
+  let getExecOutputSpy: jest.SpyInstance;

  beforeEach(() => {
    // @actions/core
@@ -103,6 +106,10 @@ describe('setup-node', () => {
      // uncomment to debug
      // process.stderr.write('log:' + line + '\n');
    });
+
+    // @actions/exec
+    getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
+    getExecOutputSpy.mockImplementation(() => 'v16.15.0');
  });

  afterEach(() => {
@@ -898,3 +905,23 @@ describe('setup-node', () => {
    );
  });
 });
+
+describe('helper methods', () => {
+  describe('parseNodeVersionFile', () => {
+    each`
+      contents                                     | expected
+      ${'12'}                                      | ${'12'}
+      ${'12.3'}                                    | ${'12.3'}
+      ${'12.3.4'}                                  | ${'12.3.4'}
+      ${'v12.3.4'}                                 | ${'12.3.4'}
+      ${'lts/erbium'}                              | ${'lts/erbium'}
+      ${'lts/*'}                                   | ${'lts/*'}
+      ${'nodejs 12.3.4'}                           | ${'12.3.4'}
+      ${'ruby 2.3.4\nnodejs 12.3.4\npython 3.4.5'} | ${'12.3.4'}
+      ${''}                                        | ${''}
+      ${'unknown format'}                          | ${'unknown format'}
+    `.it('parses "$contents"', ({contents, expected}) => {
+      expect(im.parseNodeVersionFile(contents)).toBe(expected);
+    });
+  });
+});
@@ -8,7 +8,7 @@ inputs:
  node-version:
    description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.'
  node-version-file:
-    description: 'File containing the version Spec of the version to use.  Examples: .nvmrc, .node-version.'
+    description: 'File containing the version Spec of the version to use.  Examples: .nvmrc, .node-version, .tool-versions.'
  architecture:
    description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.'
  check-latest:
@@ -30,6 +30,8 @@ inputs:
 outputs:
  cache-hit: 
    description: 'A boolean value to indicate if a cache was hit.'
+  node-version:
+    description: 'The installed node version.'
 runs:
  using: 'node16'
  main: 'dist/setup/index.js'
@@ -56,7 +56,7 @@ steps:

 ## Node version file

-The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc` or `.node-version`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used.
+The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc`, `.node-version` or `.tool-versions`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used.
 See [supported version syntax](https://github.com/actions/setup-node#supported-version-syntax)
 > The action will search for the node version file relative to the repository root.

@@ -247,3 +247,5 @@ steps:
 # `npm rebuild` will run all those post-install scripts for us.
 - run: npm rebuild && npm run prepare --if-present
 ```
+
+NOTE: As per https://github.com/actions/setup-node/issues/49 you cannot use `secrets.GITHUB_TOKEN` to access private GitHub Packages within the same organisation but in a different repository.
@@ -14,7 +14,7 @@
        "@actions/exec": "^1.1.0",
        "@actions/github": "^1.1.0",
        "@actions/glob": "^0.2.0",
-        "@actions/http-client": "^2.0.1",
+        "@actions/http-client": "^1.0.11",
        "@actions/io": "^1.0.2",
        "@actions/tool-cache": "^1.5.4",
        "semver": "^6.1.1"
@@ -56,6 +56,14 @@
        "minimatch": "^3.0.4"
      }
    },
+    "node_modules/@actions/cache/node_modules/@actions/http-client": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
+      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
+      "dependencies": {
+        "tunnel": "^0.0.6"
+      }
+    },
    "node_modules/@actions/cache/node_modules/uuid": {
      "version": "3.4.0",
      "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz",
@@ -73,14 +81,6 @@
        "@actions/http-client": "^1.0.11"
      }
    },
-    "node_modules/@actions/core/node_modules/@actions/http-client": {
-      "version": "1.0.11",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
-      "dependencies": {
-        "tunnel": "0.0.6"
-      }
-    },
    "node_modules/@actions/exec": {
      "version": "1.1.0",
      "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.0.tgz",
@@ -108,11 +108,11 @@
      }
    },
    "node_modules/@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
+      "version": "1.0.11",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
+      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
      "dependencies": {
-        "tunnel": "^0.0.6"
+        "tunnel": "0.0.6"
      }
    },
    "node_modules/@actions/io": {
@@ -133,14 +133,6 @@
        "uuid": "^3.3.2"
      }
    },
-    "node_modules/@actions/tool-cache/node_modules/@actions/http-client": {
-      "version": "1.0.11",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
-      "dependencies": {
-        "tunnel": "0.0.6"
-      }
-    },
    "node_modules/@azure/abort-controller": {
      "version": "1.0.4",
      "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.0.4.tgz",
@@ -5119,6 +5111,14 @@
            "minimatch": "^3.0.4"
          }
        },
+        "@actions/http-client": {
+          "version": "2.0.1",
+          "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
+          "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
+          "requires": {
+            "tunnel": "^0.0.6"
+          }
+        },
        "uuid": {
          "version": "3.4.0",
          "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz",
@@ -5132,16 +5132,6 @@
      "integrity": "sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==",
      "requires": {
        "@actions/http-client": "^1.0.11"
-      },
-      "dependencies": {
-        "@actions/http-client": {
-          "version": "1.0.11",
-          "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-          "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
-          "requires": {
-            "tunnel": "0.0.6"
-          }
-        }
      }
    },
    "@actions/exec": {
@@ -5171,11 +5161,11 @@
      }
    },
    "@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
+      "version": "1.0.11",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
+      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
      "requires": {
-        "tunnel": "^0.0.6"
+        "tunnel": "0.0.6"
      }
    },
    "@actions/io": {
@@ -5194,16 +5184,6 @@
        "@actions/io": "^1.0.1",
        "semver": "^6.1.0",
        "uuid": "^3.3.2"
-      },
-      "dependencies": {
-        "@actions/http-client": {
-          "version": "1.0.11",
-          "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-          "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
-          "requires": {
-            "tunnel": "0.0.6"
-          }
-        }
      }
    },
    "@azure/abort-controller": {
@@ -8,7 +8,7 @@
    "build": "ncc build -o dist/setup src/setup-node.ts && ncc build -o dist/cache-save src/cache-save.ts",
    "format": "prettier --write **/*.ts",
    "format-check": "prettier --check **/*.ts",
-    "test": "jest",
+    "test": "jest --coverage",
    "pre-checkin": "npm run format && npm run build && npm test"
  },
  "repository": {
@@ -28,7 +28,7 @@
    "@actions/exec": "^1.1.0",
    "@actions/github": "^1.1.0",
    "@actions/glob": "^0.2.0",
-    "@actions/http-client": "^2.0.1",
+    "@actions/http-client": "^1.0.11",
    "@actions/io": "^1.0.2",
    "@actions/tool-cache": "^1.5.4",
    "semver": "^6.1.1"
@@ -13,7 +13,7 @@ export interface PackageManagerInfo {

 export const supportedPackageManagers: SupportedPackageManagers = {
  npm: {
-    lockFilePatterns: ['package-lock.json', 'yarn.lock'],
+    lockFilePatterns: ['package-lock.json', 'npm-shrinkwrap.json', 'yarn.lock'],
    getCacheFolderCommand: 'npm config get cache'
  },
  pnpm: {
@@ -495,12 +495,16 @@ function translateArchToDistUrl(arch: string): string {
 }

 export function parseNodeVersionFile(contents: string): string {
-  let nodeVersion = contents.trim();
+  const found = contents.match(/^(?:nodejs\s+)?v?(?<version>[^\s]+)$/m);
+  const nodeVersion = found?.groups?.version;

-  if (/^v\d/.test(nodeVersion)) {
-    nodeVersion = nodeVersion.substring(1);
+  if (nodeVersion) {
+    return nodeVersion;
  }
-  return nodeVersion;
+
+  // In the case of an unknown format,
+  // return as is and evaluate the version separately.
+  return contents.trim();
 }

 function isLatestSyntax(versionSpec): boolean {
@@ -1,4 +1,5 @@
 import * as core from '@actions/core';
+import * as exec from '@actions/exec';
 import * as installer from './installer';
 import fs from 'fs';
 import * as auth from './authutil';
@@ -39,6 +40,14 @@ export async function run() {
      await installer.getNode(version, stable, checkLatest, auth, arch);
    }

+    // Output version of node is being used
+    const {stdout: installedVersion} = await exec.getExecOutput(
+      'node',
+      ['--version'],
+      {ignoreReturnCode: true}
+    );
+    core.setOutput('node-version', installedVersion);
+
    const registryUrl: string = core.getInput('registry-url');
    const alwaysAuth: string = core.getInput('always-auth');
    if (registryUrl) {
Author	SHA1	Message	Date
Marko Zivic	5b949b50c3	Merge pull request #373 from ganta/add-support-for-asdf-format-as-node-version-file Add support for asdf format as Node.js version file	2022-07-11 13:48:55 +02:00
Christian Clauss	09ba51f18e	README.md: Encourage testing on current Node.js (#533 )	2022-07-07 14:53:32 +02:00
AJ Jordan	b3ca1ac971	Support npm-shrinkwrap.json out-of-the-box (#439 )	2022-07-04 23:29:56 +02:00
Marko Zivic	78faa555e1	Merge pull request #534 from panva/set-version-output set node-version output (2022 edition)	2022-07-04 14:45:20 +02:00
Marko Zivic	0f15a51ed6	Merge pull request #528 from jamesottaway/patch-1 docs: Include warning when configuring token to install private packages	2022-07-04 10:38:01 +02:00
Filip Skokan	460f88643a	fixup mocked version output	2022-07-01 01:30:18 +02:00
Filip Skokan	d8b0944270	add mock for getExecOutput in installer.test.ts	2022-07-01 01:27:37 +02:00
James Ottaway	0ad06209dd	Update advanced-usage.md	2022-07-01 09:12:46 +10:00
Filip Skokan	adeb189fd8	apply review feedback	2022-07-01 00:46:13 +02:00
Filip Skokan	0d7418813c	run build&format	2022-07-01 00:28:26 +02:00
Filip Skokan	3ac35dad40	This PR adds `node-version` to the action output. This is present in e.g. setup-python https://github.com/actions/setup-python/blob/main/action.yml closes #150	2022-06-30 21:56:36 +02:00
Marko Zivic	7d610f0c26	Merge pull request #526 from IvanZosimov/CacheVersionUpdate Add support for the @actions/cache library 3.0.0	2022-06-28 10:07:26 +02:00
IvanZosimov	bcb9f31327	Format cache-save.test.ts	2022-06-27 10:19:35 +02:00
IvanZosimov	73ea510762	Update unit-tests for cache-save.ts file, add coverage option to Jest	2022-06-27 10:17:28 +02:00
IvanZosimov	eaead3517c	Update cache-save.ts to support @actions/cache v3.0.0 lib	2022-06-27 10:11:42 +02:00
James Ottaway	24301fe9fb	docs: Include warning when configuring token to install private packages The distinction between `secrets.GITHUB_TOKEN` and `secrets.NPM_TOKEN` cost myself and a colleague numerous hours when we were trying to fix a GitHub Actions workflow which needed to install a private package from a different repository from our GitHub organisation. Given the issue dedicated to this point is closed, we should include a warning here to make it more clear why `secrets.GITHUB_TOKEN` will not work when passed to `npm ci`, in the presence of private packages from other GitHub Package repositories.	2022-06-27 09:28:13 +10:00
Ivan	11c7f932ce	Merge pull request #2 from dmitry-shibanov/v-dmshib/cacheVersionUpdate Update licenses	2022-06-24 14:53:04 +02:00
Dmitry Shibanov	f1702f8f38	update licenses	2022-06-24 12:47:26 +02:00
IvanZosimov	1196f2ae1b	Rebuild action with the new @actions/cache dependency	2022-06-24 12:36:36 +02:00
IvanZosimov	c22fc3c628	Update the version of @actions/cache library to 3.0.0	2022-06-24 12:22:20 +02:00
Hideki Igarashi	dbb64ac1d1	Add support for asdf format as Node.js version file	2022-05-30 20:13:04 +09:00
Hideki Igarashi	82496765f3	Add tests for parseNodeVersionFile	2022-05-30 20:05:14 +09:00