From ce01da25772ec77000d7cf16688b8713fefb994c Mon Sep 17 00:00:00 2001 From: Dmitry Shibanov Date: Wed, 9 Nov 2022 21:16:59 +0100 Subject: [PATCH] fix documentation --- __tests__/README.md | 6 +++--- docs/advanced-usage.md | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/__tests__/README.md b/__tests__/README.md index bbb4ac06..c1489843 100644 --- a/__tests__/README.md +++ b/__tests__/README.md @@ -5,6 +5,6 @@ Files located in data directory are used only for testing purposes. - `.nvmrc`, `.tools-versions` and `package.json` are used to test node-version-file logic - `package-lock.json`, `pnpm-lock.yaml` and `yarn.lock` are used to test cache logic - `versions-manifest.json` is used for unit testing to check downloading Node.js versions from the node-versions repository. - - `node-dist-index.json` is used for unit testing to check downloading Node.js versions from the official site. - - `node-rc-index.json` is used for unit testing to check downloading Node.js rc versions from the official site. - - `node-nightly-index.json` is used for unit testing to check downloading Node.js nightly builds from the official site. \ No newline at end of file + - `node-dist-index.json` is used for unit testing to check downloading Node.js versions from the official site. The file was constructed from https://nodejs.org/dist/index.json + - `node-rc-index.json` is used for unit testing to check downloading Node.js rc versions from the official site. The file was constructed from https://nodejs.org/download/rc/index.json + - `node-nightly-index.json` is used for unit testing to check downloading Node.js nightly builds from the official site. The file was constructed from https://nodejs.org/download/nightly/index.json \ No newline at end of file diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index c2a8374e..4789f2ea 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -108,7 +108,7 @@ jobs: You can specify a nightly version to download it from https://nodejs.org/download/nightly. -### Install nightly build for specific node version +### Install the nightly build for a major version ```yaml jobs: @@ -119,12 +119,12 @@ jobs: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: - node-version: '16.0.0-nightly' # it will install the latest nigthly release for node 16.0.0 + node-version: '16-nightly' # it will install the latest nightly release for node 16 - run: npm ci - run: npm test ``` -### Install nightly build for major node version +### Install the nightly build for a specific version ```yaml jobs: @@ -135,12 +135,12 @@ jobs: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: - node-version: '16-nightly' # it will install the latest nigthly release for node 16 + node-version: '16.0.0-nightly' # it will install the latest nightly release for node 16.0.0 - run: npm ci - run: npm test ``` -### Install the exact nightly version +### Install an exact nightly version ```yaml jobs: @@ -174,7 +174,7 @@ jobs: - run: npm test ``` -**Note:** You should specify the exact version for rc: `16.0.0-rc.1`. +**Note:** Unlike nightly versions, which support version range specifiers, you must specify the exact version for a release candidate: `16.0.0-rc.1`. ## Caching packages data The action follows [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) guidelines, and caches global cache on the machine instead of `node_modules`, so cache can be reused between different Node.js versions.