docs: add special volta usage

This commit is contained in:
Jef LeCompte 2022-06-29 12:30:42 -07:00
parent a03d9f05e4
commit f40b60859d
No known key found for this signature in database
GPG Key ID: 7F5BA322B5DC170C
1 changed files with 3 additions and 1 deletions

View File

@ -56,8 +56,10 @@ steps:
## Node version file
The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc` or `.node-version`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used.
The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc` or `.node-version`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used. In the special case of using `volta`, the action will use `package.json` and look for the `volta.node` key.
See [supported version syntax](https://github.com/actions/setup-node#supported-version-syntax)
> The action will search for the node version file relative to the repository root.
```yaml