Use node-version instead of version (#28)

* Use node-version instead of version

* Add deprecation date

README.md

@@ -1,5 +1,9 @@
 # setup-node
 
+<p align="left">
+  <a href="https://github.com/actions/setup-node"><img alt="GitHub Actions status" src="https://github.com/actions/setup-node/workflows/Main%20workflow/badge.svg"></a>
+</p>
+
 This action sets by node environment for use in actions by:
 
 - optionally downloading and caching a version of node - npm by version spec and add to PATH
@@ -15,7 +19,7 @@ steps:
 - uses: actions/checkout@master
 - uses: actions/setup-node@v1
   with:
-    version: '10.x'
+    node-version: '10.x'
 - run: npm install
 - run: npm test
 ```
@@ -34,38 +38,50 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v1
         with:
-          version: ${{ matrix.node }}
+          node-version: ${{ matrix.node }}
       - run: npm install
       - run: npm test
 ```
 
-Set up auth with npm:
+Publish to npmjs and GPR with npm:
 ```yaml
 steps:
 - uses: actions/checkout@master
 - uses: actions/setup-node@v1
   with:
-    version: '10.x'
+    node-version: '10.x'
-    registry-url: <registry url>
+    registry-url: 'https://registry.npmjs.org'
 - run: npm install
 - run: npm publish
   env:
     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+- uses: actions/setup-node@v1
+  with:
+    registry-url: 'https://npm.pkg.github.com'
+- run: npm publish
+  env:
+    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-Set up auth with yarn:
+Publish to npmjs and GPR with yarn:
 ```yaml
 steps:
 - uses: actions/checkout@master
 - uses: actions/setup-node@v1
   with:
-    version: '10.x'
+    node-version: '10.x'
     registry-url: <registry url>
 - run: npm install -g yarn
 - run: yarn install
 - run: yarn publish
   env:
     NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }}
+- uses: actions/setup-node@v1
+  with:
+    registry-url: 'https://npm.pkg.github.com'
+- run: yarn publish
+  env:
+    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 # License

__tests__/__snapshots__/authutil.test.ts.snap

@@ -0,0 +1,21 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`installer tests Appends trailing slash to registry 1`] = `
+"//registry.npmjs.org/:_authToken=\${NODE_AUTH_TOKEN}
+registry=https://registry.npmjs.org/"
+`;
+
+exports[`installer tests Automatically configures GPR scope 1`] = `
+"npm.pkg.github.com/:_authToken=\${NODE_AUTH_TOKEN}
+@owner:registry=npm.pkg.github.com/"
+`;
+
+exports[`installer tests Configures scoped npm registries 1`] = `
+"//registry.npmjs.org/:_authToken=\${NODE_AUTH_TOKEN}
+@myScope:registry=https://registry.npmjs.org/"
+`;
+
+exports[`installer tests Sets up npmrc for npmjs 1`] = `
+"//registry.npmjs.org/:_authToken=\${NODE_AUTH_TOKEN}
+registry=https://registry.npmjs.org/"
+`;

__tests__/authutil.test.ts

@@ -0,0 +1,62 @@
+import io = require('@actions/io');
+import fs = require('fs');
+import path = require('path');
+
+const tempDir = path.join(
+  __dirname,
+  'runner',
+  path.join(
+    Math.random()
+      .toString(36)
+      .substring(7)
+  ),
+  'temp'
+);
+
+const rcFile = path.join(tempDir, '.npmrc');
+
+process.env['GITHUB_REPOSITORY'] = 'owner/repo';
+process.env['RUNNER_TEMP'] = tempDir;
+import * as auth from '../src/authutil';
+
+describe('installer tests', () => {
+  beforeAll(async () => {
+    await io.rmRF(tempDir);
+    await io.mkdirP(tempDir);
+  }, 100000);
+
+  beforeEach(() => {
+    if (fs.existsSync(rcFile)) {
+      fs.unlinkSync(rcFile);
+    }
+    process.env['INPUT_SCOPE'] = '';
+  });
+
+  it('Sets up npmrc for npmjs', async () => {
+    await auth.configAuthentication('https://registry.npmjs.org/');
+    expect(fs.existsSync(rcFile)).toBe(true);
+    expect(fs.readFileSync(rcFile, {encoding: 'utf8'})).toMatchSnapshot();
+  });
+
+  it('Appends trailing slash to registry', async () => {
+    await auth.configAuthentication('https://registry.npmjs.org');
+
+    expect(fs.existsSync(rcFile)).toBe(true);
+    expect(fs.readFileSync(rcFile, {encoding: 'utf8'})).toMatchSnapshot();
+  });
+
+  it('Configures scoped npm registries', async () => {
+    process.env['INPUT_SCOPE'] = 'myScope';
+    await auth.configAuthentication('https://registry.npmjs.org');
+
+    expect(fs.existsSync(rcFile)).toBe(true);
+    expect(fs.readFileSync(rcFile, {encoding: 'utf8'})).toMatchSnapshot();
+  });
+
+  it('Automatically configures GPR scope', async () => {
+    await auth.configAuthentication('npm.pkg.github.com');
+
+    expect(fs.existsSync(rcFile)).toBe(true);
+    expect(fs.readFileSync(rcFile, {encoding: 'utf8'})).toMatchSnapshot();
+  });
+});

__tests__/installer.test.ts

@@ -4,7 +4,7 @@ import os = require('os');
 import path = require('path');
 
 const toolDir = path.join(
-  process.cwd(),
+  __dirname,
   'runner',
   path.join(
     Math.random()
@@ -14,7 +14,7 @@ const toolDir = path.join(
   'tools'
 );
 const tempDir = path.join(
-  process.cwd(),
+  __dirname,
   'runner',
   path.join(
     Math.random()
@@ -36,15 +36,6 @@ describe('installer tests', () => {
     await io.rmRF(tempDir);
   }, 100000);
 
-  afterAll(async () => {
-    try {
-      await io.rmRF(toolDir);
-      await io.rmRF(tempDir);
-    } catch {
-      console.log('Failed to remove test directories');
-    }
-  }, 100000);
-
   it('Acquires version of node if no matching version is installed', async () => {
     await installer.getNode('10.16.0');
     const nodeDir = path.join(toolDir, 'node', '10.16.0', os.arch());

action.yml

@@ -1,14 +1,17 @@
-name: 'Setup Node.js for use with actions'
+name: 'Setup Node.js environment'
 description: 'Setup a Node.js environment and add it to the PATH, additionally providing proxy support'
 author: 'GitHub'
-inputs: 
+inputs:
-  version:
+  node-version:
-    description: 'Version Spec of the version to use.  Examples: 10.x, 10.15.1, >=10.15.0, lts'
+    description: 'Version Spec of the version to use.  Examples: 10.x, 10.15.1, >=10.15.0'
     default: '10.x'
   registry-url:
     description: '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'
   scope:
     description: 'Optional scope for authenticating against scoped registries'
+# Deprecated option, do not use. Will not be supported after October 1, 2019
+  version:
+    description: 'Deprecated. Use node-version instead. Will not be supported after October 1, 2019'
 runs:
   using: 'node12'
   main: 'lib/setup-node.js'

lib/authutil.js

@@ -13,11 +13,10 @@ const path = __importStar(require("path"));
 const core = __importStar(require("@actions/core"));
 const github = __importStar(require("@actions/github"));
 function configAuthentication(registryUrl) {
-    // const npmrc: string = path.resolve(
+    const npmrc = path.resolve(process.env['RUNNER_TEMP'] || process.cwd(), '.npmrc');
-    //   process.env['RUNNER_TEMP'] || process.cwd(),
+    if (!registryUrl.endsWith('/')) {
-    //   '.npmrc'
+        registryUrl += '/';
-    // );
+    }
-    const npmrc = path.resolve(process.cwd(), '.npmrc');
     writeRegistryToFile(registryUrl, npmrc);
 }
 exports.configAuthentication = configAuthentication;
@@ -45,9 +44,9 @@ function writeRegistryToFile(registryUrl, fileLocation) {
     const registryString = scope
         ? `${scope}:registry=${registryUrl}`
         : `registry=${registryUrl}`;
-    newContents += `${registryString}${os.EOL}${authString}`;
+    newContents += `${authString}${os.EOL}${registryString}`;
     fs.writeFileSync(fileLocation, newContents);
     core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation);
     // Export empty node_auth_token so npm doesn't complain about not being able to find it
-    // core.exportVariable('NODE_AUTH_TOKEN', 'XXXXX-XXXXX-XXXXX-XXXXX');
+    core.exportVariable('NODE_AUTH_TOKEN', 'XXXXX-XXXXX-XXXXX-XXXXX');
 }

lib/setup-node.js

@@ -26,7 +26,10 @@ function run() {
             // Version is optional.  If supplied, install / use from the tool cache
             // If not supplied then task is still used to setup proxy, auth, etc...
             //
-            const version = core.getInput('version');
+            let version = core.getInput('version');
+            if (!version) {
+                version = core.getInput('node-version');
+            }
             if (version) {
                 // TODO: installer doesn't support proxy
                 yield installer.getNode(version);

src/authutil.ts

@@ -5,17 +5,19 @@ import * as core from '@actions/core';
 import * as github from '@actions/github';
 
 export function configAuthentication(registryUrl: string) {
-  // const npmrc: string = path.resolve(
+  const npmrc: string = path.resolve(
-  //   process.env['RUNNER_TEMP'] || process.cwd(),
+    process.env['RUNNER_TEMP'] || process.cwd(),
-  //   '.npmrc'
+    '.npmrc'
-  // );
+  );
-  const npmrc: string = path.resolve(process.cwd(), '.npmrc');
+  if (!registryUrl.endsWith('/')) {
+    registryUrl += '/';
+  }
 
   writeRegistryToFile(registryUrl, npmrc);
 }
 
 function writeRegistryToFile(registryUrl: string, fileLocation: string) {
-  let scope = core.getInput('scope');
+  let scope: string = core.getInput('scope');
   if (!scope && registryUrl.indexOf('npm.pkg.github.com') > -1) {
     scope = github.context.repo.owner;
   }
@@ -35,14 +37,14 @@ function writeRegistryToFile(registryUrl: string, fileLocation: string) {
     });
   }
   // Remove http: or https: from front of registry.
-  const authString =
+  const authString: string =
-    registryUrl.replace(/(^\w+:|^)/, '') + `:_authToken=${NODE_AUTH_TOKEN}`;
+    registryUrl.replace(/(^\w+:|^)/, '') + ':_authToken=${NODE_AUTH_TOKEN}';
-  const registryString = scope
+  const registryString: string = scope
     ? `${scope}:registry=${registryUrl}`
     : `registry=${registryUrl}`;
-  newContents += `${registryString}${os.EOL}${authString}`;
+  newContents += `${authString}${os.EOL}${registryString}`;
   fs.writeFileSync(fileLocation, newContents);
-//   core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation);
+  core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation);
   // Export empty node_auth_token so npm doesn't complain about not being able to find it
-  // core.exportVariable('NODE_AUTH_TOKEN', 'XXXXX-XXXXX-XXXXX-XXXXX');
+  core.exportVariable('NODE_AUTH_TOKEN', 'XXXXX-XXXXX-XXXXX-XXXXX');
 }

src/setup-node.ts

@@ -9,7 +9,10 @@ async function run() {
     // Version is optional.  If supplied, install / use from the tool cache
     // If not supplied then task is still used to setup proxy, auth, etc...
     //
-    const version = core.getInput('version');
+    let version = core.getInput('version');
+    if (!version) {
+      version = core.getInput('node-version');
+    }
     if (version) {
       // TODO: installer doesn't support proxy
       await installer.getNode(version);