feat(node-version): raised the minimum required version to v14.17 (#2132)

BREAKING CHANGE: the minimum required version of node is now v14.17
2021-09-17 13:05:32 -07:00
parent 1632e1adac
commit 66cc2b4c7f
15 changed files with 986 additions and 2239 deletions
@@ -45,7 +45,7 @@ Yes, **semantic-release** is a Node CLI application, but it can be used to publi
 To publish a non-Node package (without a `package.json`) you would need to:
 - Use a [global](../usage/installation.md#global-installation) **semantic-release** installation
 - Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration)
- Make sure your CI job executing the `semantic-release` command has access to [Node >= 10.19](#why-does-semantic-release-require-node-version--1019) to execute the `semantic-release` command
+- Make sure your CI job executing the `semantic-release` command has access to [Node >= 14.17](#why-does-semantic-release-require-node-version--1417) to execute the `semantic-release` command

 See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.

@@ -204,9 +204,9 @@ See [“Introduction to SemVer” - Irina Gebauer](https://blog.greenkeeper.io/i

 In addition the [verify conditions step](../../README.md#release-steps) verifies that all necessary conditions for proceeding with a release are met, and a new release will be performed [only if all your tests pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).

-## Why does semantic-release require Node version >= 10.19?
+## Why does semantic-release require Node version >= 14.17?

-**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which **requires Node version 10.19 or higher**.
+**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which **requires Node version 14.17 or higher**.

 See [Node version requirement](./node-version.md#node-version-requirement) for more details and solutions.

@@ -1,6 +1,6 @@
 # Node Support Policy

-We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 10.19 (LTS)](https://nodejs.org/en/blog/release/v10.19.0).
+We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 14.17.0 (LTS)](https://nodejs.org/en/blog/release/v14.17.0).

 We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.

@@ -1,16 +1,17 @@
 # Node version requirement

-**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which **requires Node version 10.19 or higher**.
+**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which requires **requires Node version 14.17 or higher**.

-**semantic-release** is meant to be used in a CI environment as a development support tool, not as a production dependency. Therefore, the only constraint is to run the `semantic-release` in a CI environment providing Node 10.19 or higher.
+**semantic-release** is meant to be used in a CI environment as a development support tool, not as a production dependency. Therefore, the only constraint is to run the `semantic-release` in a CI environment providing Node 14.17 or higher.

 See our [Node Support Policy](node-support-policy.md) for our long-term promise regarding Node version support.

 ## Recommended solution

-### Run at least one CI job with Node >= 10.19
+### Run at least one CI job with Node >= 14.17

-The recommended approach is to run the `semantic-release` command from a CI job running on Node 10.19 or higher. This can either be a job used by your project to test on Node >= 10.19 or a dedicated job for the release steps.
+The recommended approach is to run the `semantic-release` command from a CI job running on Node 14.17 or higher.
+This can either be a job used by your project to test on Node >= 14.17 or a dedicated job for the release steps.

 See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.

@@ -18,18 +19,19 @@ See [CI configuration](../usage/ci-configuration.md) and [CI configuration recip

 ### Use `npx`

-`npx` is included with npm >= 5.2 and can be used to download the latest [Node 10 package published on npm](https://www.npmjs.com/package/node). Use it to execute the `semantic-release` command.
+`npx` is included with npm >= 5.2 and can be used to download the latest [Node 14 package published on npm](https://www.npmjs.com/package/node).
+Use it to execute the `semantic-release` command.

 ```bash
-$ npx -p node@10 -c "npx semantic-release"
+$ npx -p node@14 -c "npx semantic-release"
 ```

 **Note:**: See [What is npx](./FAQ.md#what-is-npx) for more details.

 ### Use `nvm`

-If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to Node 10.19 before running the `semantic-release` command.
+If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to Node 14.17 before running the `semantic-release` command.

 ```bash
-$ nvm install 10.19 && npx semantic-release
+$ nvm install 14.17 && npx semantic-release
 ```