Merge pull request #219 from actions/v-malob/update-readme-v2

Update readme before releasing actions/setup-node V2

.github/workflows/build-test.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Setup node 12
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: 12.x
       - run: npm ci

README.md

@@ -10,14 +10,14 @@ This action sets by node environment for use in actions by:
 - registering problem matchers for error output
 - configuring authentication for GPR or npm
 
-# v2-beta
+# v2
 
-A beta release which adds reliability for pulling node distributions from a cache of node releases is available by referencing the `v2-beta` tag.
+This release adds reliability for pulling node distributions from a cache of node releases.
 
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v2-beta
+- uses: actions/setup-node@v2
   with:
     node-version: '12'
 ```
@@ -34,7 +34,7 @@ Basic:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     node-version: '12'
 - run: npm install
@@ -47,7 +47,7 @@ Check latest version:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v2-beta
+- uses: actions/setup-node@v2
   with:
     node-version: '12'
     check-latest: true
@@ -67,7 +67,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
       - run: npm install
@@ -86,7 +86,7 @@ jobs:
     name: Node sample
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: '12'
           architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default
@@ -121,7 +121,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node_version }}
           architecture: ${{ matrix.architecture }}
@@ -133,7 +133,7 @@ Publish to npmjs and GPR with npm:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     node-version: '10.x'
     registry-url: 'https://registry.npmjs.org'
@@ -141,7 +141,7 @@ steps:
 - run: npm publish
   env:
     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     registry-url: 'https://npm.pkg.github.com'
 - run: npm publish
@@ -153,7 +153,7 @@ Publish to npmjs and GPR with yarn:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     node-version: '10.x'
     registry-url: <registry url>
@@ -161,7 +161,7 @@ steps:
 - run: yarn publish
   env:
     NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }}
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     registry-url: 'https://npm.pkg.github.com'
 - run: yarn publish
@@ -173,7 +173,7 @@ Use private packages:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@v2
   with:
     node-version: '10.x'
     registry-url: 'https://registry.npmjs.org'

__tests__/authutil.test.ts

@@ -123,4 +123,13 @@ describe('authutil tests', () => {
     expect(rc['registry']).toBe('https://registry.npmjs.org/');
     expect(rc['always-auth']).toBe('true');
   });
+  it('It is already set the NODE_AUTH_TOKEN export it ', async () => {
+    process.env.NODE_AUTH_TOKEN = 'foobar';
+    await auth.configAuthentication('npm.pkg.github.com', 'false');
+    expect(fs.statSync(rcFile)).toBeDefined();
+    let rc = readRcFile(rcFile);
+    expect(rc['@ownername:registry']).toBe('npm.pkg.github.com/');
+    expect(rc['always-auth']).toBe('false');
+    expect(process.env.NODE_AUTH_TOKEN).toEqual('foobar');
+  });
 });

dist/index.js

@@ -4803,8 +4803,8 @@ function writeRegistryToFile(registryUrl, fileLocation, alwaysAuth) {
     newContents += `${authString}${os.EOL}${registryString}${os.EOL}${alwaysAuthString}`;
     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');
+    // Export empty node_auth_token if didn't exist so npm doesn't complain about not being able to find it
+    core.exportVariable('NODE_AUTH_TOKEN', process.env.NODE_AUTH_TOKEN || 'XXXXX-XXXXX-XXXXX-XXXXX');
 }
 //# sourceMappingURL=authutil.js.map
 

src/authutil.ts

@@ -53,6 +53,9 @@ function writeRegistryToFile(
   newContents += `${authString}${os.EOL}${registryString}${os.EOL}${alwaysAuthString}`;
   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');
+  // Export empty node_auth_token if didn't exist so npm doesn't complain about not being able to find it
+  core.exportVariable(
+    'NODE_AUTH_TOKEN',
+    process.env.NODE_AUTH_TOKEN || 'XXXXX-XXXXX-XXXXX-XXXXX'
+  );
 }