Skip to content

Commit b287e17

Browse files
authored
Document * vs. current/latest/node difference (#508)
1 parent eeb10cf commit b287e17

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,13 @@ The `node-version` input supports the following values:
4040
- Major versions: `12`, `14`, `16`
4141
- More specific versions: `10.15`, `14.2.0`, `16.3.0`
4242
- NVM LTS syntax: `lts/erbium`, `lts/fermium`, `lts/*`, `lts/-n`
43-
- Latest release: `latest`/`current`/`node`
43+
- Latest release: `*` or `latest`/`current`/`node`
4444

45-
**Note:** Since the latest release will not be cached always, there is possibility of hitting rate limit when downloading from dist
45+
**Note:** Like the other values, `*` will get the latest [locally-cached Node.js version](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-Readme.md#nodejs), or the latest version from [actions/node-versions](https://github.com/actions/node-versions/blob/main/versions-manifest.json), depending on the [`check-latest`](docs/advanced-usage.md#check-latest-version) input.
46+
47+
`current`/`latest`/`node` always resolve to the latest [dist version](https://nodejs.org/dist/index.json).
48+
That version is then downloaded from actions/node-versions if possible, or directly from Node.js if not.
49+
Since it will not be cached always, there is possibility of hitting rate limit when downloading from dist
4650

4751
### Checking in lockfiles
4852

0 commit comments

Comments
 (0)