actions/setup-node
1
0
Fork 0
mirror of https://github.com/actions/setup-node.git synced 2025-04-24 12:22:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix documentation

Browse source
This commit is contained in:
Dmitry Shibanov 2022-11-09 21:16:59 +01:00
parent 30128bf68c
commit ce01da2577
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
__tests__/README.md
View file

@ -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 - `.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 - `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. - `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-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. - `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. - `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

12
docs/advanced-usage.md
View file

@ -108,7 +108,7 @@ jobs:
You can specify a nightly version to download it from https://nodejs.org/download/nightly. 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 ```yaml
jobs: jobs:
@ -119,12 +119,12 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: 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 ci
- run: npm test - run: npm test
``` ```
### Install nightly build for major node version ### Install the nightly build for a specific version
```yaml ```yaml
jobs: jobs:
@ -135,12 +135,12 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: 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 ci
- run: npm test - run: npm test
``` ```
### Install the exact nightly version ### Install an exact nightly version
```yaml ```yaml
jobs: jobs:
@ -174,7 +174,7 @@ jobs:
- run: npm test - 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 ## 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. 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.