Updated readme with caching

akv-platform · Jun 17, 2021 · 1e068f0 · 1e068f0
1 parent 7528c33
commit 1e068f0
Showing 1 changed file with 37 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -4,50 +4,69 @@
   <a href="https://github.com/actions/setup-node/actions?query=workflow%3Abuild-test"><img alt="build-test status" src="https://github.com/actions/setup-node/workflows/build-test/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aversions"><img alt="versions status" src="https://github.com/actions/setup-node/workflows/versions/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aproxy"><img alt="proxy status" src="https://github.com/actions/setup-node/workflows/proxy/badge.svg"></a> 
 </p>
 
-This action sets by node environment for use in actions by:
+This action provides the following functionality for GitHub Actions runners:
 
-- optionally downloading and caching a version of node - npm by version spec and add to PATH
-- registering problem matchers for error output
-- configuring authentication for GPR or npm
+- Optionally downloading and caching distribution of the requested Node.js version, and adding it to the PATH
+- Optionally caching npm/yarn dependencies
+- Registering problem matchers for error output
+- Configuring authentication for GPR or npm
 
-# v2
+# Usage
 
-This release adds reliability for pulling node distributions from a cache of node releases.
+See [action.yml](action.yml)
 
+Basic:
 ```yaml
 steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v2
   with:
     node-version: '14'
+- run: npm install
+- run: npm test
 ```
 
-The action will first check the local cache for a semver match. The hosted images have been updated with the latest of each LTS from v8, v10, v12, and v14. `self-hosted` machines will benefit from the cache as well only downloading once. The action will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/).
+The `node-version` input is optional. If not supplied, the node version from PATH will be used. However, this action will still register problem matchers and support auth features. So setting up the node environment is still a valid scenario without downloading and caching versions.
 
-The `node-version` input is optional. If not supplied, the node version that is PATH will be used. However, this action will still register problem matchers and support auth features. So setting up the node environment is still a valid scenario without downloading and caching versions.
+Caching npm dependencies:
 
-# Usage
+The action has a built-in functionality for caching and restoring npm/yarn dependencies. Supported package managers are `npm`, `yarn`. The `cache` input is optional, and caching is turned off by default.
 
-See [action.yml](action.yml)
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: actions/setup-node@v2
+  with:
+    node-version: '14'
+    cache: 'npm'
+- run: npm install
+- run: npm test
+```
 
-Basic:
+Caching yarn dependencies:
 ```yaml
 steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v2
   with:
     node-version: '14'
+    cache: 'yarn'
 - run: npm install
 - run: npm test
 ```
+Yarn caching handles both yarn versions: 1 or 2. 
+
+> At the moment, only `lock` files in the project root are supported.
 
 Check latest version:
 
-In the basic example above, the `check-latest` flag defaults to `false`. When set to `false`, the action tries to first resolve a version of node from the local cache. For information regarding locally cached versions of Node on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments). The local version of Node in cache gets updated every couple of weeks. If unable to find a specific version in the cache, the action will then attempt to download a version of Node. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node is always used.
+The `check-latest` flag defaults to `false`. When set to `false`, the action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Node.js. It will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/). Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node.js is always used.
 
-If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a version of Node will then be downloaded. Set `check-latest` to `true` it you want the most up-to-date version of Node to always be used.
+For information regarding locally cached versions of Node.js on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments).
 
-> Setting `check-latest` to `true` has performance implications as downloading versions of Node is slower than using cached versions
+If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a version of Node.js will then be downloaded. Set `check-latest` to `true` it you want the most up-to-date version of Node.js to always be used.
+
+> Setting `check-latest` to `true` has performance implications as downloading versions of Node is slower than using cached versions.
 
 ```yaml
 steps:
@@ -64,7 +83,7 @@ Matrix Testing:
 ```yaml
 jobs:
   build:
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         node: [ '12', '14' ]
@@ -140,7 +159,7 @@ steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v2
   with:
-    node-version: '10.x'
+    node-version: '14.x'
     registry-url: 'https://registry.npmjs.org'
 - run: npm install
 - run: npm publish
@@ -160,7 +179,7 @@ steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v2
   with:
-    node-version: '10.x'
+    node-version: '14.x'
     registry-url: <registry url>
 - run: yarn install
 - run: yarn publish
@@ -180,7 +199,7 @@ steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v2
   with:
-    node-version: '10.x'
+    node-version: '14.x'
     registry-url: 'https://registry.npmjs.org'
 # Skip post-install scripts here, as a malicious
 # script could steal NODE_AUTH_TOKEN.
@@ -191,7 +210,6 @@ steps:
 - run: npm rebuild && npm run prepare --if-present
 ```
 
-
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)