diff --git a/README.md b/README.md index 4dc22ca..476b569 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,8 @@ jobs: ## Versions -By default, versions will be updated to reflect the 'even' versions of Node -which are not end-of-life. This means that versions that will not be promoted to -LTS are ignored. +By default, versions will be updated to reflect the 'current' and 'LTS' versions +of Node which are not end-of-life. Optionally, you can configure the action to use another strategy for selecting Node versions. @@ -88,13 +87,13 @@ updaters are enabled. These updaters are available: ## Inputs -| name | default | description | -| ----------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `versions` |
lts
lts/-1
lts/-2
| Node versions to select, should be resolvable by [node-version-alias](https://www.npmjs.com/package/node-version-alias). Specify each version on a new line. | -| `versions.filter-eol` | `true` | Filter out Node versions which are end-of-life. [Source](https://github.com/nodejs/Release/blob/main/schedule.json) used for filtering. | -| `updaters.workflows` | `true` | Update GitHub workflows. | -| `updaters.workflows.variable` | `"node-version"` | Use this name as the matrix strategy variable to update the Node versions in. | -| `updaters.engines` | `true` | Update package.json `engines`. | +| name | default | description | +| ----------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `versions` |
latest
lts
lts/-1
lts/-2
| Node versions to select, should be resolvable by [node-version-alias](https://www.npmjs.com/package/node-version-alias). Specify each version on a new line. | +| `versions.filter-eol` | `true` | Filter out Node versions which are end-of-life. [Source](https://github.com/nodejs/Release/blob/main/schedule.json) used for filtering. | +| `updaters.workflows` | `true` | Update GitHub workflows. | +| `updaters.workflows.variable` | `"node-version"` | Use this name as the matrix strategy variable to update the Node versions in. | +| `updaters.engines` | `true` | Update package.json `engines`. | All inputs are optional. Example: diff --git a/action.yml b/action.yml index d3e681a..c7655da 100644 --- a/action.yml +++ b/action.yml @@ -8,6 +8,7 @@ inputs: description: Node versions to select required: true default: | + latest lts lts/-1 lts/-2