actions/setup-node
1
0
Fork 0
mirror of https://github.com/actions/setup-node.git synced 2026-03-01 06:41:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: consolidate advanced usage

Browse Source 
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
This commit is contained in:
Ferdinand Thiessen 2026-02-17 18:35:34 +01:00
parent f3b3cab24b
commit 3b57a0f39b
No known key found for this signature in database
GPG Key ID: 7E849AE05218500F
1 changed files with 4 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/advanced-usage.md
View File

@ -92,41 +92,25 @@ steps:
When using the `package.json` input, the action will look in the following fields for a specified Node version: When using the `package.json` input, the action will look in the following fields for a specified Node version:
1. It checks `volta.node` first. 1. It checks `volta.node` first.
2. Then it checks `devEngines.runtime`. 2. Then it checks `devEngines.runtime` for an entry with `"name": "node"`.
3. Then it will look for `engines.node`. 3. Then it will look for `engines.node`.
4. Otherwise it tries to resolve the file defined by [`volta.extends`](https://docs.volta.sh/advanced/workspaces) 4. Otherwise it tries to resolve the file defined by [`volta.extends`](https://docs.volta.sh/advanced/workspaces)
and look for `volta.node`, `devEngines.runtime`, or `engines.node` recursively. and look for `volta.node`, `devEngines.runtime`, or `engines.node` recursively.
### Example with `devEngines`
When a runtime engine (`engines.node`) is defined but also a development engine (`devEngines.runtime`) then the `devEngines.runtime` version is used.
This example will install a Node version based on the `^20.10` pattern.
```json ```json
{ {
"engines": { "engines": {
"node": "^19" "node": "^22 || ^24"
}, },
"devEngines": { "devEngines": {
"runtime": { "runtime": {
"name": "node", "name": "node",
"version": "^20.10" "version": "^24.3"
} }
}
}
```
### Example with volta pinned Node version
When both `engines.node` and `volta.node` is defined the value in `volta.node` is used.
```json
{
"engines": {
"node": ">=16.0.0"
}, },
"volta": { "volta": {
"node": "16.0.0" "node": "24.11.1"
} }
} }
``` ```