Skip to content
Snippets Groups Projects
Unverified Commit f72fb854 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs: improve Node.js documentation (#7822)


* split up long sentence

* use active voice

* use 1's for ordered list, fix whitespace

* split sentence, and rewrite in active voice

* Implement review suggestion

Co-authored-by: default avatarRhys Arkins <rhys@arkins.net>

Co-authored-by: default avatarRhys Arkins <rhys@arkins.net>
parent cd00101b
No related branches found
No related tags found
No related merge requests found
......@@ -5,11 +5,12 @@ description: Node.js versions support in Renovate
# Node.js Versions
Renovate can upgrade the [Node.js](https://nodejs.org/en/) runtime used by your project so that you're using the latest bug fixes, performance improvements, security mitigations, etc. that meet your project's unique needs.
Renovate can upgrade the [Node.js](https://nodejs.org/en/) runtime used by your project.
This way you're using the latest bug fixes, performance improvements, security mitigations, etc.
## File Support
Renovate is capable of managing the Node.js version in the following files:
Renovate can manage the Node.js version in the following files:
- The [`engines`](https://docs.npmjs.com/files/package.json#engines) field in [`package.json`](https://docs.npmjs.com/files/package.json)
- The [`volta`](https://docs.volta.sh/guide/understanding#managing-your-project) field in [`package.json`](https://docs.npmjs.com/files/package.json)
......@@ -23,7 +24,7 @@ Node.js renovation in `package.json > engines` and in `.nvmrc` is enabled by def
To enable `.travis.yml` renovation, you must:
1. Enable Travis renovation explicitly by setting the following Renovate configuration: `"travis": { "enabled": true }`
2. Optionally, configure a support policy (As documented below)
1. Optionally, configure a support policy (As documented below)
When Renovate processes your project's repository it will look for the files listed above and submit a single pull request that upgrades all Node.js versions simultaneously.
......@@ -50,6 +51,7 @@ For example, to instruct Renovate to upgrade your project to the latest [Long-te
"supportPolicy": ["lts_latest"]
```
It's best to define this support policy inside the `node` configuration object so that it is applied to all Node.js-related files.
We recommend that you define this support policy inside the `node` configuration object.
This way, it is applied to all Node.js-related files.
For additional language support see the [`supportPolicy` documentation](/configuration-options/#supportpolicy).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment