fix(npm-plugin): upgraded to the beta, which upgrades npm to v8

BREAKING CHANGE: `@semantic-release/npm` has also dropped support for node v15
fix: upgrade marked to resolve ReDos vulnerability (#2330 )
2022-01-17 12:52:51 -06:00 · 2022-01-17 11:17:27 -06:00 · 2022-01-07 17:28:12 +00:00 · 2021-12-21 09:24:12 -08:00 · 2021-12-07 16:38:58 +00:00 · 2021-12-02 10:06:37 -08:00
34 changed files with 22350 additions and 2873 deletions
@@ -1,12 +1,11 @@
 name: Release
-on:
+"on":
  push:
    branches:
      - master
      - next
      - beta
-      - "*.x" # maintenance releases branches
-
+      - "*.x"
 jobs:
  release:
    name: release
@@ -16,6 +15,7 @@ jobs:
      - uses: actions/setup-node@v2
        with:
          cache: npm
+          node-version: 16
      - run: npm ci
      - run: npx semantic-release
        env:
@@ -17,9 +17,9 @@ jobs:
    strategy:
      matrix:
        node-version:
-          - 10.18.0
-          - 12
-          - 14
+          - 14.17
+          - 16.0.0
+          - 17

    runs-on: ubuntu-latest

@@ -32,8 +32,6 @@ jobs:
        with:
          node-version: ${{ matrix.node-version }}
          cache: npm
-      - name: Ensure dependencies are compatible with the version of node
-        run: echo 'engine-strict=true' >> .npmrc
      - run: npm ci
      - run: npm run test:ci

@@ -46,6 +44,9 @@ jobs:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
+          node-version: 16
          cache: npm
      - run: npm ci
+      - name: Ensure dependencies are compatible with the version of node
+        run: npx ls-engines@0.4
      - run: npm run lint
@@ -20,45 +20,55 @@ Help us keep **semantic-release** open and inclusive. Please read and follow our

 ### Improve documentation

-As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
+As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).

 Please follow the [Documentation guidelines](#documentation).

 ### Give feedback on issues

-Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information.
+Some issues are created without information requested in the [Bug report guideline](#bug-report).
+Help make them easier to resolve by adding any relevant information.

-Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
+Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features.
+Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.

 ### Fix bugs and implement features

-Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
+Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22).
+Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.

 ## Using the issue tracker

-The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
+The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only.
+Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.

 Before opening an issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make sure the bug or feature request hasn't been already reported or fixed.

 ### Bug report

-A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the [Bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md).
+A good bug report shouldn't leave others needing to chase you for more information.
+Please try to be as detailed as possible in your report and fill the information requested in the [bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=01_bug_report.md).

 ### Feature request

-Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the [Feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md).
+Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project.
+It's up to you to make a strong case to convince the project's developers of the merits of this feature.
+Please provide as much detail and context as possible and fill the information requested in the [feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=02_feature_request.md).

 ### New plugin request

-[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
+[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type.
+Please provide as much detail and context as possible and fill the information requested in the [plugin suggestion template](https://github.com/semantic-release/semantic-release/issues/new?template=03_plugin_suggestion.md).

 ## Submitting a Pull Request

-Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+Good pull requests, whether patches, improvements, or new features, are a fantastic help.
+They should remain focused in scope and avoid containing unrelated commits.

-**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's maintainers might not want to merge into the project.

-If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
+If you have never created a pull request before, welcome 🎉 😄.
+[Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)

 Here is a summary of the steps to follow:

@@ -83,7 +93,9 @@ $ git push origin <topic-branch-name>

 **Tips**:
 - For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community.
- [Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This way, we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them.
+- [Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
+  This way, we can rebase it and make some minor changes if necessary.
+  All changes we make will be done in new commit, and we'll ask for your approval before merging them.

 ## Coding rules

@@ -129,7 +141,8 @@ A complex feature can be broken down into multiple commits as long as each one m

 #### Commit message format

-Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
+Each commit message consists of a **header**, a **body** and a **footer**.
+The header has a special format that includes a **type**, a **scope** and a **subject**:

 ```commit
 <type>(<scope>): <subject>
@@ -145,7 +158,8 @@ The **footer** can contain a [closing reference to an issue](https://help.github

 #### Revert

-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
+In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

 #### Type

@@ -178,7 +192,8 @@ The body should include the motivation for the change and contrast this with pre
 #### Footer
 The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.

-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+The rest of the commit message is then used for this.

 #### Examples

@@ -219,7 +234,8 @@ $ npm install

 ### Lint

-All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO.
+All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting.
+Prettier formatting will be automatically verified and fixed by XO.

 Before pushing your code changes make sure there are no linting errors with `npm run lint`.

@@ -8,7 +8,7 @@
    <img alt="Build states" src="https://github.com/semantic-release/semantic-release/workflows/Test/badge.svg">
  </a>
  <a href="#badge">
-    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+    <img alt="semantic-release: angular" src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release">
  </a>
 </p>
 <p align="center">
@@ -23,9 +23,9 @@
  </a>
 </p>

-**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
+**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the package.

-This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification.
+This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification and communicating the **impact** of changes to consumers.

 > Trust us, this will change your workflow for the better. – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)

@@ -37,18 +37,20 @@ This removes the immediate connection between human emotions and version numbers
 - Notify maintainers and users of new releases
 - Use formalized commit message convention to document changes in the codebase
 - Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
- Integrate with your [continuous integration workflow](docs/recipes/README.md#ci-configurations)
+- Integrate with your [continuous integration workflow](docs/recipes/release-workflow/README.md#ci-configurations)
 - Avoid potential errors associated with manual releases
- Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
+- Support any [package managers and languages](docs/recipes/release-workflow/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
 - Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)

 ## How does it work?

 ### Commit message format

-**semantic-release** uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
+**semantic-release** uses the commit messages to determine the consumer impact of changes in the codebase.
+Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.

-By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
+By default, **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
+The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.

 Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint](https://github.com/conventional-changelog/commitlint) can be used to help contributors and enforce valid commit messages.

@@ -56,23 +58,25 @@ The table below shows which commit message gets you which release type when `sem

 | Commit message                                                                                                                                                                                   | Release type               |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
-| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | Patch Release              |
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release      |
 | `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release  |
-| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

 ### Automation with CI

-**semantic-release** is meant to be executed on the CI environment after every successful build on the release branch. This way no human is directly involved in the release process and the releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org).
+**semantic-release** is meant to be executed on the CI environment after every successful build on the release branch.
+This way no human is directly involved in the release process and the releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org).

 ### Triggering a release

-For each new commits added to one of the release branches (for example `master`, `next`, `beta`), with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities.
+For each new commit added to one of the release branches (for example: `master`, `next`, `beta`), with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities.

-**semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:
+**semantic-release** offers various ways to control the timing, the content and the audience of published releases.
+See example workflows in the following recipes:

- [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
- [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases)
- [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases)
+- [Using distribution channels](docs/recipes/release-workflow/distribution-channels.md#publishing-on-distribution-channels)
+- [Maintenance releases](docs/recipes/release-workflow/maintenance-releases.md#publishing-maintenance-releases)
+- [Pre-releases](docs/recipes/release-workflow/pre-releases.md#publishing-pre-releases)

 ### Release steps

@@ -96,8 +100,8 @@ In order to use **semantic-release** you need:

 - To host your code in a [Git repository](https://git-scm.com)
 - Use a Continuous Integration service that allows you to [securely set up credentials](docs/usage/ci-configuration.md#authentication)
- Git CLI version [2.7.1 or higher](docs/support/FAQ.md#why-does-semantic-release-require-git-version--271) installed in your Continuous Integration environment
- [Node.js](https://nodejs.org) version [10.18 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--1018) installed in your Continuous Integration environment
+- A Git CLI version that meets [our version requirement](docs/support/git-version.md) installed in your Continuous Integration environment
+- A [Node.js](https://nodejs.org) version that meets [our version requirement](docs/support/node-version.md) installed in your Continuous Integration environment

 ## Documentation

@@ -113,10 +117,9 @@ In order to use **semantic-release** you need:
  - [Plugins](docs/extending/plugins-list.md)
  - [Shareable configuration](docs/extending/shareable-configurations-list.md)
 - Recipes
-  - [CI configurations](docs/recipes/README.md)
-  - [Git hosted services](docs/recipes/README.md)
-  - [Release workflow](docs/recipes/README.md)
-  - [Package managers and languages](docs/recipes/README.md)
+  - [CI configurations](docs/recipes/ci-configurations/README.md)
+  - [Git hosted services](docs/recipes/git-hosted-services/README.md)
+  - [Release workflow](docs/recipes/release-workflow/README.md)
 - Developer guide
  - [JavaScript API](docs/developer-guide/js-api.md)
  - [Plugins development](docs/developer-guide/plugin.md)
@@ -130,18 +133,19 @@ In order to use **semantic-release** you need:

 ## Get help

- [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
 - [GitHub Discussions](https://github.com/semantic-release/semantic-release/discussions)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
 - [Twitter](https://twitter.com/SemanticRelease)

 ## Badge

-Let people know that your package is published using **semantic-release** by including this badge in your readme.
+Let people know that your package is published using **semantic-release** and which [commit-convention](#commit-message-format) is followed by including this badge in your readme.

-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

 ```md
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
 ```

 ## Team
@@ -14,13 +14,18 @@
 - [Shareable configuration](docs/extending/shareable-configurations-list.md)

 ## Recipes
- [CI configurations](docs/recipes/README.md#ci-configurations)
-	- [CircleCI 2.0](docs/recipes/circleci-workflows.md)
-	- [Travis CI](docs/recipes/travis.md)
-	- [GitLab CI](docs/recipes/gitlab-ci.md)
- [Git hosted services](docs/recipes/README.md#git-hosted-services)
-	- [Git authentication with SSH keys](docs/recipes/git-auth-ssh-keys.md)
- [Package managers and languages](docs/recipes/README.md#package-managers-and-languages)
+- [CI configurations](docs/recipes/ci-configurations/README.md)
+  - [CircleCI 2.0](docs/recipes/ci-configurations/circleci-workflows.md)
+  - [Travis CI](docs/recipes/ci-configurations/travis.md)
+  - [GitLab CI](docs/recipes/ci-configurations/gitlab-ci.md)
+  - [GitHub Actions](docs/recipes/ci-configurations/github-actions.md)
+  - [Jenkins CI](docs/recipes/ci-configurations/jenkins-ci.md)
+- [Git hosted services](docs/recipes/git-hosted-services/README.md)
+  - [Git authentication with SSH keys](docs/recipes/git-hosted-services/git-auth-ssh-keys.md)
+- [Release Workflow](docs/recipes/release-workflow/README.md)
+  - [Publishing on distribution channels](docs/recipes/release-workflow/distribution-channels.md)
+  - [Publishing maintenance releases](docs/recipes/release-workflow/maintenance-releases.md)
+  - [Publishing pre-releases](docs/recipes/release-workflow/pre-releases.md)

 ## Developer guide
 - [JavaScript API](docs/developer-guide/js-api.md)
@@ -33,3 +38,4 @@
 - [Troubleshooting](docs/support/troubleshooting.md)
 - [Node version requirement](docs/support/node-version.md)
 - [Node Support Policy](docs/support/node-support-policy.md)
+- [Git version requirement](docs/support/git-version.md)
@@ -2,6 +2,6 @@

 - [Usage](usage/README.md) - **semantic-release** installation and configuration
 - [Extending](extending/README.md) - Extending **semantic-release** with plugins and shareable configurations
- [Recipes](recipes/README.md) - Community written recipes for common **semantic-release** use-cases
+- [Recipes](recipes/release-workflow/README.md) - Community written recipes for common **semantic-release** use-cases
 - [Developer Guide](developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
 - [Support](support/README.md) - FAQ and troubleshooting
@@ -34,7 +34,7 @@ We recommend you setup a linting system to ensure good javascript practices are
 In your `index.js` file, you can start by writing the following code

 ```javascript
-const verifyConditions = require('./src/verify');
+const verify = require('./src/verify');

 let verified;

@@ -43,12 +43,12 @@ let verified;
 * @param {*} pluginConfig The semantic-release plugin config
 * @param {*} context The context provided by semantic-release
 */
-async function verify(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context);
+async function verifyConditions(pluginConfig, context) {
+  await verify(pluginConfig, context);
  verified = true;
 }

-module.exports = { verify };
+module.exports = { verifyConditions };
 ```

 Then, in your `src` folder, create a file called `verify.js` and add the following
@@ -237,6 +237,20 @@ if (env.GITHUB_TOKEN) {
  //...
 }
 ```
+## Logger
+Use `context.logger` to provide debug logging in the plugin.
+
+```js
+const { logger } = context;
+
+logger.log('Some message from plugin.'). 
+```
+
+The above usage yields the following where `PLUGIN_PACKAGE_NAME` is automatically inferred.
+
+```
+[3:24:04 PM] [semantic-release] [PLUGIN_PACKAGE_NAME] › ℹ  Some message from plugin.
+```

 ## Execution order

@@ -54,7 +54,8 @@
  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
 - [@semantic-release-plus/docker](https://github.com/semantic-release-plus/semantic-release-plus/tree/master/packages/plugins/docker)
  - `verifyConditions`: Verify that all needed configuration is present and login to the configured docker registry.
-  - `publish`: Tag the image specified by `name` with the new version, push it to the configured docker registry and update the `latest`, `major`, `minor` tags based on the configuration settings.
+  - `publish`: Tag the image specified by `name` with the new version and channel and push it to the configured docker registry.
+  - `addChannel`: Updates a release published on one channel with the destinations channel tag and pushes to the registry ie: next to latest.
 - [semantic-release-gcr](https://github.com/carlos-cubas/semantic-release-gcr)
  - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry
  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
@@ -140,3 +141,19 @@
  - `verifyConditions`: Validate configuration and verify ```HEROKU_API_KEY```
  - `prepare`: Update the package.json version and create release tarball
  - `publish`: Publish version to heroku
+- [semantic-release-mattermost](https://github.com/ttrobisch/semantic-release-mattermost)
+  - `verifyConditions`: Verify that the webhook is setup and release-notes-generator is present.
+  - `success`: Send a message about the new release and its notes to a [mattermost](https://mattermost.com/) webhook.
+- [semantic-release-github-milestones](https://github.com/nitzano/semantic-release-github-milestones)
+  - `verifyConditions`: Verify github tokens are present and valid.
+  - `verifyRelease`: Display information regarding the matching github milestone.
+- [semantic-release-telegram-bot](https://github.com/skoropadas/semantic-release-telegram-bot)
+  - `verifyConditions`: Validate configuration and verify `TELEGRAM_BOT_TOKEN` and package name
+  - `success`: Publish a success message to certain telegram chats
+  - `fail`: Publish a fail message to certain telegram chats
+- [semantic-release-npm-deprecate](https://github.com/jpoehnelt/semantic-release-npm-deprecate)
+  - `publish`: Automatically mark old versions as deprecated.
+- [@eshepelyuk/semantic-release-helm-oci](https://github.com/eshepelyuk/semantic-release-helm-oci)
+  - `verifyConditions`: Verify plugin configuration and login to Helm registry
+  - `prepare`: Package Helm chart to local folder
+  - `publish`: Publish Helm chart to OCI registry
@@ -1,18 +0,0 @@
-# Recipes
-
-## CI configurations
- [CircleCI 2.0 workflows](circleci-workflows.md)
- [Travis CI](travis.md)
- [GitLab CI](gitlab-ci.md)
- [GitHub Actions](github-actions.md)
- [Jenkins CI](jenkins-ci.md)
-
-## Git hosted services
- [Git authentication with SSH keys](git-auth-ssh-keys.md)
-
-## Release workflow
- [Publishing on distribution channels](distribution-channels.md)
- [Publishing maintenance releases](maintenance-releases.md)
- [Publishing pre-releases](pre-releases.md)
-
-## Package managers and languages
@@ -0,0 +1,6 @@
+# CI configurations
+- [CircleCI 2.0 workflows](circleci-workflows.md)
+- [Travis CI](travis.md)
+- [GitLab CI](gitlab-ci.md)
+- [GitHub Actions](github-actions.md)
+- [Jenkins CI](jenkins-ci.md)
@@ -2,19 +2,22 @@

 ## Environment variables

-The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..
+The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..

-Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
+Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).

 ## Multiple Node jobs configuration

 ### `.circleci/config.yml` configuration for multiple Node jobs

-This example is a minimal configuration for **semantic-release** with tests running against Node 16 and 14. See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.
+This example is a minimal configuration for **semantic-release** with tests running against Node 16 and 14.
+See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.

 In this example, the [`circleci/node`](https://circleci.com/developer/orbs/orb/circleci/node) orb is imported (Which makes some node operations easier), then a `release` job is defined which will run `semantic-release`.

-To run our `release` job, we have created a workflow named `test_and_release` which will run two jobs, `node/test`, which comes from the node orb and will test our application, and our release job. Here, we are actually making use of [matrix jobs](https://circleci.com/blog/circleci-matrix-jobs/) so that our single `node/test` job will actually be executed twice, once for Node version 16, and once for version 14. Finally, we call our release job with a `requires` parameter so that `release` will only run after `node/test` has successfully tested against v14 and v16.
+To run our `release` job, we have created a workflow named `test_and_release` which will run two jobs, `node/test`, which comes from the node orb and will test our application, and our release job.
+Here, we are actually making use of [matrix jobs](https://circleci.com/blog/circleci-matrix-jobs/) so that our single `node/test` job will actually be executed twice, once for Node version 16, and once for version 14.
+Finally, we call our release job with a `requires` parameter so that `release` will run against the latest LTS version of node, only after `node/test` has successfully tested against v14 and v16.

 ```yaml
 version: 2.1
@@ -25,6 +28,8 @@ jobs:
    executor: node/default
    steps:
      - checkout
+      - node/install
+          lts: true
      - node/install-packages # Install and automatically cache packages
      # Run optional required steps before releasing
      # - run: npm run build-script
@@ -39,20 +44,8 @@ workflows:
            parameters:
              version:
                - 16.1.0
-                - 14.7.0
+                - 14.17.0
      - release:
          requires:
            - node/test
 ```
-
-### `package.json` configuration for multiple Node jobs
-
-A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
-
-```json
-{
-  "devDependencies": {
-    "semantic-release": "^15.0.0"
-  }
-}
-```
@@ -2,7 +2,7 @@

 ## Environment variables

-The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret Variables](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables).
+The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret Variables](https://docs.github.com/en/actions/reference/encrypted-secrets).

 In this example a publish type [`NPM_TOKEN`](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) is required to publish a package to the npm registry. GitHub Actions [automatically populate](https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret) a [`GITHUB_TOKEN`](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) environment variable which can be used in Workflows.

@@ -10,11 +10,12 @@ In this example a publish type [`NPM_TOKEN`](https://docs.npmjs.com/creating-and

 [GitHub Actions](https://github.com/features/actions) support [Workflows](https://help.github.com/en/articles/configuring-workflows), allowing to run tests on multiple Node versions and publish a release only when all test pass.

-**Note**: The publish pipeline must run on [Node version >= 10.18](../support/FAQ.md#why-does-semantic-release-require-node-version--1018).
+**Note**: The publish pipeline must run on a [Node version that meets our version requirement](../../support/node-version.md).

 ### `.github/workflows/release.yml` configuration for Node projects

-The following is a minimal configuration for [`semantic-release`](https://github.com/semantic-release/semantic-release) with a build running on Node 12 when a new commit is pushed to a `master` branch. See [Configuring a Workflow](https://help.github.com/en/articles/configuring-a-workflow) for additional configuration options.
+The following is a minimal configuration for [`semantic-release`](https://github.com/semantic-release/semantic-release) with a build running on the latest LTS version of Node when a new commit is pushed to a `master` branch.
+See [Configuring a Workflow](https://help.github.com/en/articles/configuring-a-workflow) for additional configuration options.

 ```yaml
 name: Release
@@ -32,9 +33,9 @@ jobs:
        with:
          fetch-depth: 0
      - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
        with:
-          node-version: 12
+          node-version: 'lts/*'
      - name: Install dependencies
        run: npm ci
      - name: Release
@@ -2,7 +2,7 @@

 ## Environment variables

-The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Protected variables](https://docs.gitlab.com/ce/ci/variables/README.html#protected-environment-variables).
+The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Protected variables](https://docs.gitlab.com/ce/ci/variables/README.html#protected-environment-variables).

 **Note**: Make sure to configure your release branch as [protected](https://docs.gitlab.com/ce/user/project/protected_branches.html) in order for the CI/CD build to access the protected variables.

@@ -10,13 +10,13 @@ The [Authentication](../usage/ci-configuration.md#authentication) environment va

 GitLab CI supports [Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) allowing to test on multiple Node versions and publishing a release only when all test pass.

-**Note**: The publish pipeline must run a [Node >= 10.18 version](../support/FAQ.md#why-does-semantic-release-require-node-version--1018).
+**Note**: The publish pipeline must run a [Node version that meets our version requirement](../../support/node-version.md).

 ### `.gitlab-ci.yml` configuration for Node projects

 This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.

-**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
+**Note**: The`semantic-release` execution command varies depending on whether you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.

 ```yaml
 # The release pipeline will run only if all jobs in the test pipeline are successful
@@ -50,11 +50,11 @@ publish:

 This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.

-**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
+**Note**: The`semantic-release` execution command varies depending if you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.


 ```yaml
-# The release pipeline will run only on the master branch a commit is triggered 
+# The release pipeline will run only on the master branch a commit is triggered
 stages:
  - release

@@ -83,7 +83,7 @@ release:

 ### `package.json` configuration

-A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.

 ```json
 {
@@ -2,24 +2,24 @@

 ## Environment variables

-The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [Jenkins Project Settings](https://www.jenkins.io/doc/pipeline/tour/environment/)..
+The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [Jenkins Project Settings](https://www.jenkins.io/doc/pipeline/tour/environment/)..

-Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
+Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).

 ## Node.js project configuration

 ### `Jenkinsfile (Declarative Pipeline)` configuration for a Node.js job

-**Note**: The publish pipeline must run a [Node >= 10.18 version](../support/FAQ.md#why-does-semantic-release-require-node-version--1018).
+**Note**: The publish pipeline must run a Node version that [meets our requirement](../../support/node-version.md).

-This example is a minimal configuration for **semantic-release** with a build running Node 10.18. See [Jenkins documentation](https://www.jenkins.io/doc/) for additional configuration options.
-
-The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
+This example is a minimal configuration for **semantic-release** with a build running a version of Node labelled as "node LTS".
+Since versions of Node are manually downloaded and labelled, we recommend keeping the version used for the release steps up-to-date with the latest LTS version.
+See the [Jenkins documentation](https://www.jenkins.io/doc/) for additional configuration options.

 ```yaml
 // The release stage in the pipeline will run only if the test stage in the pipeline is successful
 pipeline {
-    agent any 
+    agent any
    environment {
        GH_TOKEN  = credentials('some-id')
    }
@@ -31,18 +31,18 @@ pipeline {
                npm install
                npm test
                '''
-                }
+            }
        }
        stage('Release') {
            tools {
-            nodejs "node 10.18"
+                nodejs "node LTS"
            }
            steps {
                sh '''
                # Run optional required steps before releasing
                npx semantic-release
                '''
-            }            
+            }
        }
    }
 }
@@ -50,12 +50,12 @@ pipeline {

 ### `package.json` configuration for a Node job

-A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.

 ```json
 {
  "devDependencies": {
-    "semantic-release": "^15.0.0"
+    "semantic-release": "^18.0.0"
  }
 }
-```
+```
@@ -2,17 +2,17 @@

 ## Environment variables

-The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [Travis Repository Settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-Settings) or with the [travis env set CLI](https://github.com/travis-ci/travis.rb#env).
+The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [Travis Repository Settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-Settings) or with the [travis env set CLI](https://github.com/travis-ci/travis.rb#env).

-Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
+Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).

 ## Node.js projects configuration

 ### `.travis.yml` configuration for multiple Node.js jobs

-This example is a minimal configuration for **semantic-release** with a build running Node 6 and 8. See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.
+This example is a minimal configuration for **semantic-release** with a build running Node 14 and 16. See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.

-This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).

 It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.

@@ -24,8 +24,8 @@ It's recommended to run the `semantic-release` command in the [Travis `deploy` s
 language: node_js

 node_js:
-  - 8
-  - 6
+  - 14
+  - 16

 jobs:
  include:
@@ -43,12 +43,12 @@ jobs:

 ### `package.json` configuration for multiple Node jobs

-A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.

 ```json
 {
  "devDependencies": {
-    "semantic-release": "^15.0.0"
+    "semantic-release": "^18.0.0"
  }
 }
 ```
@@ -57,13 +57,13 @@ A `package.json` is required only for [local](../usage/installation.md#local-ins

 For projects that require to be tested with one or multiple version of a Non-JavaScript [language](https://docs.travis-ci.com/user/languages), optionally on multiple [Operating Systems](https://docs.travis-ci.com/user/multi-os).

-This recipe cover the Travis specifics only. See [Non JavaScript projects recipe](../support/FAQ.md#can-i-use-semantic-release-to-publish-non-javascript-packages) for more information on the **semantic-release** configuration.
+This recipe cover the Travis specifics only. See [Non JavaScript projects recipe](../../support/FAQ.md#can-i-use-semantic-release-to-publish-non-javascript-packages) for more information on the **semantic-release** configuration.

 ### `.travis.yml` configuration for non-JavaScript projects

 This example is a minimal configuration for **semantic-release** with a build running [Go 1.6 and 1.7](https://docs.travis-ci.com/user/languages/go). See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.

-This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).

 It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.

@@ -0,0 +1,2 @@
+# Git hosted services
+- [Git authentication with SSH keys](git-auth-ssh-keys.md)
@@ -1,6 +1,6 @@
 # Git authentication with SSH keys

-When using [environment variables](../usage/ci-configuration.md#authentication) to set up the Git authentication, the remote Git repository will automatically be accessed via [https](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_http_protocols), independently of the [`repositoryUrl`](../usage/configuration.md#repositoryurl) format configured in the **semantic-release** [Configuration](../usage/configuration.md#configuration) (the format will be automatically converted as needed).
+When using [environment variables](../../usage/ci-configuration.md#authentication) to set up the Git authentication, the remote Git repository will automatically be accessed via [https](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_http_protocols), independently of the [`repositoryUrl`](../../usage/configuration.md#repositoryurl) format configured in the **semantic-release** [Configuration](../../usage/configuration.md#configuration) (the format will be automatically converted as needed).

 Alternatively the Git repository can be accessed via [SSH](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_ssh_protocol) by creating SSH keys, adding the public one to your Git hosted account and making the private one available on the CI environment.

@@ -0,0 +1,4 @@
+# Release workflow
+- [Publishing on distribution channels](distribution-channels.md)
+- [Publishing maintenance releases](maintenance-releases.md)
+- [Publishing pre-releases](pre-releases.md)
@@ -3,8 +3,8 @@
 This recipe will walk you through a simple example that uses distribution channels to make releases available only to a subset of users, in order to collect feedbacks before distributing the release to all users.

 This example uses the **semantic-release** default configuration:
- [branches](../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
- [plugins](../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`
+- [branches](../../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
+- [plugins](../../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`

 ## Initial release

@@ -3,8 +3,8 @@
 This recipe will walk you through a simple example that uses Git branches and distribution channels to publish fixes and features for old versions of a package.

 This example uses the **semantic-release** default configuration:
- [branches](../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
- [plugins](../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`
+- [branches](../../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
+- [plugins](../../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`

 ## Initial release

@@ -18,7 +18,7 @@ The Git history of the repository is:

 ## Releasing a breaking change

-We now decide to drop Node.js 6 support for our package, and require Node.js 8 or higher, which is a breaking change.  
+We now decide to drop Node.js 6 support for our package, and require Node.js 8 or higher, which is a breaking change.

 We commit that change with the message `feat: drop Node.js 6 support \n\n BREAKING CHANGE: Node.js >= 8 required` to `master`. When pushing that commit, **semantic-release** will release the version `2.0.0` on the dist-tag `@latest`.

@@ -3,8 +3,8 @@
 This recipe will walk you through a simple example that uses pre-releases to publish beta versions while working on a future major release and then make only one release on the default distribution.

 This example uses the **semantic-release** default configuration:
- [branches](../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
- [plugins](../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`
+- [branches](../../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
+- [plugins](../../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`

 ## Initial release

@@ -38,48 +38,18 @@ If using npm hook scripts is not possible, and alternative solution is to [`@sem

 Yes with the [dry-run options](../usage/configuration.md#dryrun) which prints to the console the next version to be published and the release notes.

-## Can I use semantic-release with Yarn?
-
-If you are using a [local](../usage/installation.md#local-installation) **semantic-release** installation and run multiple CI jobs with different versions, the `yarn install` command will fail on jobs running with Node < 8 as **semantic-release** requires [Node >= 10.18](#why-does-semantic-release-require-node-version--1018) and specifies it in its `package.json`s [`engines`](https://docs.npmjs.com/files/package.json#engines) key.
-
-The recommended solution is to use the [Yarn](https://yarnpkg.com) [--ignore-engines](https://yarnpkg.com/en/docs/cli/install#toc-yarn-install-ignore-engines) option to install the project dependencies on the CI environment, so Yarn will ignore the **semantic-release**'s `engines` key:
-
-```bash
-$ yarn install --ignore-engines
-```
-
-**Note**: Several CI services use Yarn by default if your repository contains a `yarn.lock` file. So you should override the install step to specify `yarn install --ignore-engines`.
-
-Alternatively you can use a [global](../usage/installation.md#global-installation) **semantic-release** installation and make sure to install and run the `semantic-release` command only in a CI jobs running with Node >= 10.18.
-
-If your CI environment provides [nvm](https://github.com/creationix/nvm) you can switch to Node 8 before installing and running the `semantic-release` command:
-
-```bash
-$ nvm install 8 && yarn global add semantic-release && semantic-release
-```
-
-See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
-
-As `semantic-release` is recommended to be executed with [`npx`](https://www.npmjs.com/package/npx) an alternative is required for usage with Yarn. Even though it is possible to install npx with Yarn, it's not recommended. Yarn and npx would be using different cache locations.
-
-For [local installation](../usage/installation.md#local-installation) replace
-`npx semantic-release` with `yarn run semantic-release`.
-
-For [global installation](../usage/installation.md#global-installation) replace
-`npx semantic-release` with `yarn global add semantic-release && semantic-release`.
-
 ## Can I use semantic-release to publish non-JavaScript packages?

-Yes, **semantic-release** is a Node CLI application but it can be used to publish any type of packages.
+Yes, **semantic-release** is a Node CLI application, but it can be used to publish any type of packages.

 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.18](#why-does-semantic-release-require-node-version--1018) to execute the `semantic-release` command
+- Make sure your CI job executing the `semantic-release` command has access to a version of Node that [meets our version requirement](./node-version.md) to execute the `semantic-release` command

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

-In addition you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.
+In addition, you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.

 If there is no specific plugin for your project type you can use the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin to publish the release with a shell command.

@@ -101,7 +71,7 @@ Here is a basic example to create [GitHub releases](https://help.github.com/arti

 **Note**: This is a theoretical example where the command `set-version` update the project version with the value passed as its first argument and `publish-package` publishes the package to a registry.

-See the [package managers and languages recipes](../recipes/README.md#package-managers-and-languages) for more details on specific project types.
+See the [package managers and languages recipes](../recipes/release-workflow/README.md#package-managers-and-languages) for more details on specific project types.

 ## Can I use semantic-release with any CI service?

@@ -109,7 +79,7 @@ Yes, **semantic-release** can be used with any CI service, as long as it provide
 - A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables
 - A way to guarantee that the `semantic-release` command is [executed only after all the tests of all the jobs in the CI build pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)

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

 ## Can I run semantic-release on my local machine rather than on a CI server?

@@ -125,7 +95,7 @@ However this is not the recommended approach, as running unit and integration te

 Yes, with the [`@semantic-release/gitlab-config`](https://github.com/semantic-release/gitlab-config) shareable configuration.

-See the [GitLab CI recipes](../recipes/gitlab-ci.md#using-semantic-release-with-gitlab-ci) for the CI configuration.
+See the [GitLab CI recipes](../recipes/ci-configurations/gitlab-ci.md#using-semantic-release-with-gitlab-ci) for the CI configuration.

 ## Can I use semantic-release with any Git hosted environment?

@@ -224,25 +194,15 @@ If you need more control over the timing of releases, see [Triggering a release]

 This is not supported by **semantic-release** as it's not considered a good practice, mostly because [Semantic Versioning](https://semver.org) rules applies differently to major version zero.

-If your project is under heavy development, with frequent breaking changes, and is not production ready yet we recommend [publishing pre-releases](../recipes/pre-releases.md#publishing-pre-releases).
+If your project is under heavy development, with frequent breaking changes, and is not production ready yet we recommend [publishing pre-releases](../recipes/release-workflow/pre-releases.md#publishing-pre-releases).

 See [“Introduction to SemVer” - Irina Gebauer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2) for more details on [Semantic Versioning](https://semver.org) and the recommendation to start at version `1.0.0`.

 ## Can I trust semantic-release with my releases?

-**semantic-release** has a full unit and integration test suite that tests `npm` publishes against the [npm-registry-couchapp](https://github.com/npm/npm-registry-couchapp).
+**semantic-release** has a full unit and integration test suite that tests `npm` publishes against the [verdaccio](https://www.npmjs.com/package/verdaccio).

-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.18?
-
-**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.18 or higher**.
-
-See [Node version requirement](./node-version.md#node-version-requirement) for more details and solutions.
-
-## Why does semantic-release require Git version >= 2.7.1?
-
-**semantic-release** uses Git CLI commands to read information about the repository such as branches, commit history and tags. Certain commands and options (such as [the `--merged` option of the `git tag` command](https://git-scm.com/docs/git-tag/2.7.0#git-tag---no-mergedltcommitgt) or bug fixes related to `git ls-files`) used by **semantic-release** are only available in Git version 2.7.1 and higher.
+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).

 ## What is npx?

@@ -0,0 +1,4 @@
+# Git version requirement
+
+**semantic-release** uses Git CLI commands to read information about the repository such as branches, commit history and tags.
+Certain commands and options (such as [the `--merged` option of the `git tag` command](https://git-scm.com/docs/git-tag/2.7.0#git-tag---no-mergedltcommitgt) or bug fixes related to `git ls-files`) used by **semantic-release** are only available in Git version 2.7.1 and higher.
@@ -1,13 +1,21 @@
 # Node Support Policy

-We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 8.9.0 (LTS)](https://nodejs.org/en/blog/release/v8.9.0).
+We will always support at least the latest [Long-Term Support](https://github.com/nodejs/Release) version of Node, but provide no promise of support for older versions.
+The supported range will always be defined in the `engines.node` property of the `package.json` of our packages.

 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.

-It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
+It's possible this package will work correctly on newer versions of Node.
+It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.

-As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.
+As new Node LTS versions become available we may remove previous versions from the `engines.node` property of our package's `package.json` file.
+Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package.
+We will not accept any requests to support an end-of-life version of Node.
+Any merge requests or issues supporting an end-of-life version of Node will be closed.

-We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
+We will accept code that allows this package to run on newer, non-LTS, versions of Node.
+Furthermore, we will attempt to ensure our own changes work on the latest version of Node.
+To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.

-JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.
+JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property.
+If you encounter issues installing this package, please report the issue to your package manager.
@@ -1,35 +1,38 @@
 # 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 **requires Node version 10 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 8 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 version of Node that meets our version requirement.

 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.18
+### Run at least one CI job with a version of Node that meets our version requirement

-The recommended approach is to run the `semantic-release` command from a CI job running on Node 10.18 or higher. This can either be a job used by your project to test on Node >= 10.18 or a dedicated job for the release steps.
+The recommended approach is to run the `semantic-release` command from a CI job running on the latest available LTS version of node.
+This can either be a job used by your project to test on the latest Node LTS version 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.
+See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/release-workflow/README.md#ci-configurations) for more details.

 ## Alternative solutions

-### Use `npx`
+### Use `npx` to execute in the latest LTS version of Node

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

 ```bash
-$ npx -p node@8 -c "npx semantic-release"
+$ npx -p node@lts -c "npx semantic-release"
 ```

-**Note:**: See [What is npx](./FAQ.md#what-is-npx) for more details.
+**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 8 before running the `semantic-release` command.
+If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to the latest LTS version of Node before running the `semantic-release` command.

 ```bash
-$ nvm install 8 && npx semantic-release
+$ nvm install 'lts/*' && npx semantic-release
 ```
@@ -65,5 +65,5 @@ To recover from that situation, do the following:

 1. Delete the tag(s) for the release(s) that have been lost from the git history. You can delete each tag from remote using `git push origin :[TAG NAME]`, e.g. `git push origin :v2.0.0-beta.1`. You can delete tags locally using `git tag -d [TAG NAME]`, e.g. `git tag -d v2.0.0-beta.1`.
 2. Re-create the tags locally: `git tag [TAG NAME] [COMMIT HASH]`, where `[COMMIT HASH]` is the new commit that created the release for the lost tag. E.g. `git tag v2.0.0-beta.1 abcdef0`
-3. Re-create the git notes for each release tag, e.g. `git notes --ref semantic-release add -f -m '{"channels":["beta"]}' v2.0.0-beta.1`. If the release was also published in the default channel (usually `master`), then set the first channel to `null`, e.g. `git notes --ref semantic-release add -f -m '{"channels":[null, "beta"]}'
+3. Re-create the git notes for each release tag, e.g. `git notes --ref semantic-release add -f -m '{"channels":["beta"]}' v2.0.0-beta.1`. If the release was also published in the default channel (usually `master`), then set the first channel to `null`, e.g. `git notes --ref semantic-release add -f -m '{"channels":[null, "beta"]}'`
 4. Push the local notes: `git push --force origin refs/notes/semantic-release`. The `--force` is needed after the rebase. Be careful.
@@ -13,7 +13,7 @@ Here is a few example of the CI services that can be used to achieve this:
 - [Wercker Workflows](http://devcenter.wercker.com/docs/workflows)
 - [GoCD Pipelines](https://docs.gocd.org/current/introduction/concepts_in_go.html#pipeline).

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

 ## Authentication

@@ -29,7 +29,7 @@ See [CI configuration recipes](../recipes/README.md#ci-configurations) for more
 | `BB_TOKEN_BASIC_AUTH` or `BITBUCKET_TOKEN_BASIC_AUTH` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html) with basic auth support. For clearification `user:token` has to be the value of this env.        |
 | `GIT_CREDENTIALS`                                     | [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding) Git username and password in the format `<username>:<password>`. The username and password must each be individually URL encoded, not the `:` separating them. |

-Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md).
+Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-hosted-services/git-auth-ssh-keys.md).

 ### Authentication for plugins

@@ -44,6 +44,6 @@ See each plugin's documentation for the environment variables required.

 The authentication token/credentials have to be made available in the CI service via environment variables.

-See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on how to configure environment variables in your CI service.
+See [CI configuration recipes](../recipes/ci-configurations/README.md) for more details on how to configure environment variables in your CI service.

 **Note**: The environment variables `GH_TOKEN`, `GITHUB_TOKEN`, `GL_TOKEN` and `GITLAB_TOKEN` can be used for both the Git authentication and the API authentication required by [@semantic-release/github](https://github.com/semantic-release/github) and [@semantic-release/gitlab](https://github.com/semantic-release/gitlab).
@@ -24,6 +24,9 @@ For other type of projects we recommend installing **semantic-release** directly
 $ npx semantic-release
 ```

-**Note**: For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@15`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
+**Note**: For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with `npx semantic-release@18`).
+This way your build will not automatically use the next major **semantic-release** release that could possibly break your build.
+You will have to upgrade manually when a new major version is released.

-**Note**: `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.
+**Note**: `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it.
+See [What is npx](../support/FAQ.md#what-is-npx) for more details.
@@ -1,12 +1,12 @@
 # Workflow configuration

 **semantic-release** allow to manage and automate complex release workflow, based on multiple Git branches and distribution channels. This allow to:
- Distributes certain releases to a particular group of users via distribution channels
+- Distribute certain releases to a particular group of users via distribution channels
 - Manage the availability of releases on distribution channels via branches merge
 - Maintain multiple lines of releases in parallel
 - Work on large future releases outside the normal flow of one version increment per Git push

-See [Release workflow recipes](../recipes/README.md#release-workflow) for detailed examples.
+See [Release workflow recipes](../recipes/release-workflow/README.md#release-workflow) for detailed examples.

 The release workflow is configured via the [branches option](./configuration.md#branches) which accepts a single or an array of branch definitions.
 Each branch can be defined either as a string, a [glob](https://github.com/micromatch/micromatch#matching-features) or an object. For string and glob definitions each [property](#branches-properties) will be defaulted.
@@ -91,7 +91,7 @@ For example the configuration `['master', {name: 'pre/rc', prerelease: '${name.r
  branches: [
    {name: 'master'},
    {name: 'pre/rc', channel: 'pre/rc', prerelease: 'rc'}, // `prerelease` is built with the template `${name.replace(/^pre\\//g, "")}`
-    {name: 'beta', channel: 'beta', prerelease: 'beta'}, // `prerelease` is set to `beta` as it is the value of `name`
+    {name: 'beta', channel: 'beta', prerelease: true}, // `prerelease` is set to `beta` as it is the value of `name`
  ]
 }
 ```
@@ -108,7 +108,7 @@ A project must define a minimum of 1 release branch and can have a maximum of 3.

 **Note:** With **semantic-release** as with most package managers, a release version must be unique, independently of the distribution channel on which it is available.

-See [publishing on distribution channels recipe](../recipes/distribution-channels.md) for a detailed example.
+See [publishing on distribution channels recipe](../recipes/release-workflow/distribution-channels.md) for a detailed example.

 #### Pushing to a release branch

@@ -142,7 +142,7 @@ Maintenance branches are always considered lower than [release branches](#releas

 **semantic-release** will automatically add releases to the corresponding distribution channel when code is [merged from a release or maintenance branch to another maintenance branch](#merging-into-a-maintenance-branch), however only versions within the branch `range` can be merged. If a merged version is outside the maintenance branch `range`, **semantic-release** will not add to the corresponding channel and will throw an `EINVALIDMAINTENANCEMERGE` error.

-See [publishing maintenance releases recipe](../recipes/maintenance-releases.md) for a detailed example.
+See [publishing maintenance releases recipe](../recipes/release-workflow/maintenance-releases.md) for a detailed example.

 #### Pushing to a maintenance branch

@@ -171,7 +171,7 @@ A pre-release branch is characterized by the `prerelease` property that defines

 When merging commits associated with an existing release, **semantic-release** will treat them as [pushed commits](#pushing-to-a-pre-release-branch) and publish a new release if necessary, but it will never add those releases to the distribution channel corresponding to the pre-release branch.

-See [publishing pre-releases recipe](../recipes/pre-releases.md) for a detailed example.
+See [publishing pre-releases recipe](../recipes/release-workflow/pre-releases.md) for a detailed example.

 #### Pushing to a pre-release branch

@@ -1,6 +1,5 @@
 const {pick} = require('lodash');
 const marked = require('marked');
-const TerminalRenderer = require('marked-terminal');
 const envCi = require('env-ci');
 const hookStd = require('hook-std');
 const semver = require('semver');
@@ -21,7 +20,16 @@ const {verifyAuth, isBranchUpToDate, getGitHead, tag, push, pushNotes, getTagHea
 const getError = require('./lib/get-error');
 const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');

-marked.setOptions({renderer: new TerminalRenderer()});
+let markedOptionsSet = false;
+async function terminalOutput(text) {
+  if (!markedOptionsSet) {
+    const {default: TerminalRenderer} = await import('marked-terminal'); // eslint-disable-line node/no-unsupported-features/es-syntax
+    marked.setOptions({renderer: new TerminalRenderer()});
+    markedOptionsSet = true;
+  }
+
+  return marked.parse(text);
+}

 /* eslint complexity: off */
 async function run(context, plugins) {
@@ -207,20 +215,20 @@ async function run(context, plugins) {
  if (options.dryRun) {
    logger.log(`Release note for version ${nextRelease.version}:`);
    if (nextRelease.notes) {
-      context.stdout.write(marked(nextRelease.notes));
+      context.stdout.write(await terminalOutput(nextRelease.notes));
    }
  }

  return pick(context, ['lastRelease', 'commits', 'nextRelease', 'releases']);
 }

-function logErrors({logger, stderr}, err) {
+async function logErrors({logger, stderr}, err) {
  const errors = extractErrors(err).sort((error) => (error.semanticRelease ? -1 : 0));
  for (const error of errors) {
    if (error.semanticRelease) {
      logger.error(`${error.code} ${error.message}`);
      if (error.details) {
-        stderr.write(marked(error.details));
+        stderr.write(await terminalOutput(error.details)); // eslint-disable-line no-await-in-loop
      }
    } else {
      logger.error('An error occurred while running semantic-release: %O', error);
@@ -234,7 +242,7 @@ async function callFail(context, plugins, err) {
    try {
      await plugins.fail({...context, errors});
    } catch (error) {
-      logErrors(context, error);
+      await logErrors(context, error);
    }
  }
 }
@@ -265,7 +273,7 @@ module.exports = async (cliOptions = {}, {cwd = process.cwd(), env = process.env
      throw error;
    }
  } catch (error) {
-    logErrors(context, error);
+    await logErrors(context, error);
    unhook();
    throw error;
  }
@@ -20,11 +20,11 @@
    "Pierre Vanduynslager (https://twitter.com/@pvdlg_)"
  ],
  "dependencies": {
-    "@semantic-release/commit-analyzer": "^8.0.0",
-    "@semantic-release/error": "^2.2.0",
-    "@semantic-release/github": "^7.0.0",
-    "@semantic-release/npm": "^7.0.0",
-    "@semantic-release/release-notes-generator": "^9.0.0",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/error": "^3.0.0",
+    "@semantic-release/github": "^8.0.0",
+    "@semantic-release/npm": "^9.0.0-beta.1",
+    "@semantic-release/release-notes-generator": "^10.0.0",
    "aggregate-error": "^3.0.0",
    "cosmiconfig": "^7.0.0",
    "debug": "^4.0.0",
@@ -37,8 +37,8 @@
    "hook-std": "^2.0.0",
    "hosted-git-info": "^4.0.0",
    "lodash": "^4.17.21",
-    "marked": "^2.0.0",
-    "marked-terminal": "^4.1.1",
+    "marked": "^4.0.10",
+    "marked-terminal": "^5.0.0",
    "micromatch": "^4.0.2",
    "p-each-series": "^2.1.0",
    "p-reduce": "^2.0.0",
@@ -51,26 +51,26 @@
  },
  "devDependencies": {
    "ava": "3.15.0",
-    "clear-module": "4.1.1",
-    "codecov": "3.8.2",
+    "clear-module": "4.1.2",
+    "codecov": "3.8.3",
    "delay": "5.0.0",
-    "dockerode": "3.3.0",
+    "dockerode": "3.3.1",
    "file-url": "3.0.0",
-    "fs-extra": "10.0.0",
-    "got": "11.8.2",
+    "fs-extra": "9.1.0",
+    "got": "11.8.3",
    "js-yaml": "4.1.0",
    "mockserver-client": "5.11.2",
-    "nock": "13.1.1",
+    "nock": "13.2.1",
    "nyc": "15.1.0",
    "p-retry": "4.6.1",
    "proxyquire": "2.1.3",
-    "sinon": "11.1.1",
+    "sinon": "12.0.1",
    "stream-buffers": "3.0.2",
    "tempy": "1.0.1",
    "xo": "0.29.1"
  },
  "engines": {
-    "node": ">=10.18"
+    "node": ">=16 || ^14.17"
  },
  "files": [
    "bin",
@@ -0,0 +1,23 @@
+storage: /verdaccio/storage/data
+plugins: /verdaccio/plugins
+web:
+  title: Verdaccio
+auth:
+  htpasswd:
+    file: /verdaccio/storage/htpasswd
+packages:
+  '@*/*':
+    access: $all
+    publish: $authenticated
+    unpublish: $authenticated
+  '**':
+    access: $all
+    publish: $authenticated
+    unpublish: $authenticated
+server:
+  keepAliveTimeout: 60
+middlewares:
+  audit:
+    enabled: true
+logs:
+  - { type: stdout, format: pretty, level: http }
@@ -1,15 +1,13 @@
 const Docker = require('dockerode');
 const getStream = require('get-stream');
 const got = require('got');
+const path = require('path');
 const delay = require('delay');
 const pRetry = require('p-retry');

-const IMAGE = 'semanticrelease/npm-registry-docker:latest';
-const SERVER_PORT = 15986;
-const COUCHDB_PORT = 5984;
-const SERVER_HOST = 'localhost';
-const COUCHDB_USER = 'admin';
-const COUCHDB_PASSWORD = 'password';
+const IMAGE = 'verdaccio/verdaccio:4';
+const REGISTRY_PORT = 4873;
+const REGISTRY_HOST = 'localhost';
 const NPM_USERNAME = 'integration';
 const NPM_PASSWORD = 'suchsecure';
 const NPM_EMAIL = 'integration@test.com';
@@ -25,8 +23,8 @@ async function start() {
  container = await docker.createContainer({
    Tty: true,
    Image: IMAGE,
-    PortBindings: {[`${COUCHDB_PORT}/tcp`]: [{HostPort: `${SERVER_PORT}`}]},
-    Env: [`COUCHDB_USER=${COUCHDB_USER}`, `COUCHDB_PASSWORD=${COUCHDB_PASSWORD}`],
+    PortBindings: {[`${REGISTRY_PORT}/tcp`]: [{HostPort: `${REGISTRY_PORT}`}]},
+    Binds: [`${path.join(__dirname, 'config.yaml')}:/verdaccio/conf/config.yaml`],
  });

  await container.start();
@@ -34,7 +32,7 @@ async function start() {

  try {
    // Wait for the registry to be ready
-    await pRetry(() => got(`http://${SERVER_HOST}:${SERVER_PORT}/registry/_design/app`, {cache: false}), {
+    await pRetry(() => got(`http://${REGISTRY_HOST}:${REGISTRY_PORT}/`, {cache: false}), {
      retries: 7,
      minTimeout: 1000,
      factor: 2,
@@ -44,9 +42,7 @@ async function start() {
  }

  // Create user
-  await got(`http://${SERVER_HOST}:${SERVER_PORT}/_users/org.couchdb.user:${NPM_USERNAME}`, {
-    username: COUCHDB_USER,
-    password: COUCHDB_PASSWORD,
+  await got(`http://${REGISTRY_HOST}:${REGISTRY_PORT}/-/user/org.couchdb.user:${NPM_USERNAME}`, {
    method: 'PUT',
    json: {
      _id: `org.couchdb.user:${NPM_USERNAME}`,
@@ -59,7 +55,7 @@ async function start() {
  });
 }

-const url = `http://${SERVER_HOST}:${SERVER_PORT}/registry/_design/app/_rewrite/`;
+const url = `http://${REGISTRY_HOST}:${REGISTRY_PORT}/`;

 const authEnv = {
  npm_config_registry: url, // eslint-disable-line camelcase
Author	SHA1	Message	Date
Matt Travi	f634b8c3ca	fix(npm-plugin): upgraded to the beta, which upgrades npm to v8 BREAKING CHANGE: `@semantic-release/npm` has also dropped support for node v15	2022-01-17 12:52:51 -06:00
Rich TrottandGitHub	d9e5bc0604	fix: upgrade `marked` to resolve ReDos vulnerability (#2330 ) BREAKING CHANGE: node v15 has been removed from our defined supported versions of node. this was done to upgrade to compatible versions of `marked` and `marked-terminal` that resolved the ReDoS vulnerability. removal of support of this node version should be low since it was not an LTS version and has been EOL for several months already.	2022-01-17 11:17:27 -06:00
Jaime Gómez-ObregónandGitHub	dd7d664aa1	docs: fix a broken link (#2318 )	2022-01-07 17:28:12 +00:00
Federico D'EreditàandGitHub	cd6136d67e	docs: wrong prerelease example (#2307 ) The documentation says: > If the `prerelease` property is set to `true` the `name` value will be used. But then the example referring to this behaviour has the the `prerelease` value set to `'beta'` instead of `true`.	2021-12-21 09:24:12 -08:00
Rommy GustiawanandGitHub	e62c83d805	docs: remove repeated 'with' word (#2289 )	2021-12-07 16:38:58 +00:00
Matt TraviandGitHub	5d78fa4045	docs(breaking-change): highlighted the need for `BREAKING CHANGE:` to be in the commit footer (#2283 ) since this is a common confusion point for new folks	2021-12-02 10:06:37 -08:00
Matt TraviandGitHub	b64855fc57	docs(badge): mentioned referencing the commit convention (#2269 )	2021-11-26 11:13:26 -08:00
Takuya FukujuandGitHub	09bcf7a86d	docs: update badges to include preset names (#2266 )	2021-11-25 23:31:49 -06:00
Matt TraviandGitHub	8e96b23a60	docs(issue-templates): fixed links to templates for opening issues (#2264 ) and broke lines after sentences	2021-11-24 10:27:50 -08:00
Eric CrossonandGitHub	5535268ad0	docs: fix typo (#2262 )	2021-11-24 10:05:42 -06:00
Alex BabelandGitHub	7f971f3a4c	fix: bump @semantic-release/commit-analyzer to 9.0.2 (#2258 )	2021-11-23 23:51:53 -06:00
Takuya FukujuandGitHub	e6366211bb	docs(troubleshooting): typo (#2254 )	2021-11-21 09:09:29 -08:00
Max BrauerandGitHub	f2a2deffc1	docs(recipes): fix path to recipes (#2253 ) * removes link to unknown “package managers and languages” recipes	2021-11-20 14:45:06 +00:00
renovate[bot]GitHub Renovate Bot	628e29e413	chore(deps): update dependency got to v11.8.3 (#2251 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-18 09:47:32 +00:00
Matt TraviandGitHub	8fda7fd423	docs(recipes): moved recipes to sub-directories to align with gitbook expectations (#2246 )	2021-11-14 10:35:20 -08:00
Justin DietzandGitHub	52d76a2a97	docs(plugin-list): updates semantic-release-plus/docker with updated lifecycle hook. (#2243 )	2021-11-12 16:07:34 -08:00
renovate[bot]GitHub Renovate Bot	f092dd1e44	chore(deps): update dependency nock to v13.2.1 (#2242 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-12 10:37:08 +00:00
Matt TraviandGitHub	03aa7d0d50	docs(badge): switched to proper semantic-release logo (#2235 )	2021-11-08 13:48:25 -06:00
Matt TraviandGitHub	bc146e49b1	docs(gitbook): updated the summary document so that missing pages are rendered by gitbook (#2234 )	2021-11-07 20:50:14 -08:00
renovate[bot]GitHub Renovate Bot	5f9d1d17ab	chore(deps): update dependency nock to v13.2.0 (#2233 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-08 03:28:04 +00:00
renovate[bot]GitHub Renovate Bot	7ff71ad55f	chore(deps): update dependency sinon to v12.0.1 (#2231 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-04 16:11:34 +00:00
Matt TraviandGitHub	d3958b80bf	Revert "chore(deps): update dependency p-retry to v5" (#2230 )	2021-11-03 15:36:35 -05:00
renovate[bot]GitHub Renovate Bot	4ae9209b1c	chore(deps): update dependency p-retry to v5 (#2229 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-03 20:24:23 +00:00
renovate[bot]GitHub Renovate Bot	32d0ab3003	chore(deps): update dependency sinon to v12 (#2227 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-03 18:14:23 +00:00
renovate[bot]GitHub Renovate Bot	0e0705937d	chore(deps): update dependency clear-module to v4.1.2 (#2226 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-11-03 18:06:13 +00:00
Ievgenii ShepeliukandGitHub	b2b07bfc00	docs(plugins): add @eshepelyuk/semantic-release-helm-oci to plugins list (#2211 ) Signed-off-by: Ievgenii Shepeliuk <eshepelyuk@gmail.com>	2021-10-30 20:32:38 +00:00
Justin PoehneltandGitHub	2ef403eb98	docs: add semantic-release-npm-deprecate plugin (#2210 )	2021-10-29 12:52:53 -07:00
Matt TraviandGitHub	0d0e0a1d8f	docs(node-version): consolidated and clarified the details about the required node version (#2170 )	2021-10-24 02:27:16 -05:00
renovate[bot]GitHub Renovate Bot	1e54e9e79a	chore(deps): update dependency ansi-regex to 5.0.1 [security] (#2197 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-10-19 19:49:14 +00:00
renovate[bot]GitHub Renovate Bot	aa866838a8	chore(deps): update dependency nock to v13.1.4 Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-10-19 12:44:44 -07:00
Justin DietzandGitHub	8db804b7dc	docs: fix plugin example (export `verifyConditions`, not `verify`) (#2192 ) plugin example was exporting `verify`, not `verifyConditions`	2021-10-18 11:50:50 -07:00
askoropadandGitHub	a50dc996b5	docs(plugins): add telegram-bot plugin to the plugin list (#2190 )	2021-10-14 19:31:45 +00:00
Nitzan OhanaandGitHub	0495cb67b2	docs: add semantic-release-github-milestones plugin (#2181 )	2021-10-11 20:26:03 +00:00
HonkingGooseandGitHub	74671f809c	docs(github-actions): update workflow version, update node-version (#2175 )	2021-10-05 09:20:34 -05:00
Matt TraviandGitHub	7faa7993eb	docs(readme): minor updates, including formating and minor clarification (#2168 )	2021-10-01 16:55:07 +00:00
ttrobischandGitHub	f79e27f588	docs: add semantic-release-mattermost to the plugin list (#2163 )	2021-10-01 16:47:58 +00:00
renovate[bot]GitHub Renovate Bot	685d2b5455	chore(deps): update dependency ssh2 to 1.4.0 [security] (#2147 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-21 21:01:14 -05:00
Justin PoehneltandGitHub	0ce4846b68	docs: add section on logger usage for plugins (#2139 )	2021-09-21 15:52:17 -07:00
renovate[bot]GitHub Renovate Bot	eb32d79ce4	chore(deps): update dependency semver-regex to 3.1.3 [security] (#2144 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-21 11:48:01 -05:00
Gregor Martynus	20034829d9	build(release.yml): set node-version to 16	2021-09-17 16:53:36 -07:00
Matt TraviandGitHub	66cc2b4c7f	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
renovate[bot]GitHub Renovate Bot	1632e1adac	chore(deps): update dependency dockerode to v3.3.1 (#2113 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-07 07:02:37 +00:00
renovate[bot]GitHub Renovate Bot	0390af32b6	chore(deps): update dependency sinon to v11.1.2 (#2108 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-04 23:46:49 +00:00
renovate[bot]GitHub Renovate Bot	e58b76e700	chore(deps): update dependency nock to v13.1.3 (#2107 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-04 23:29:44 +00:00
renovate[bot]GitHub Renovate Bot	5e228a1cd1	chore(deps): update dependency codecov to v3.8.3 (#2106 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-09-04 23:11:33 +00:00
RozandGitHub	23d2bc2842	docs: fix broken link on github actions recipe (#2102 ) The link to the secrets and environment variables was broken since the documentation changed. I pointed the link to the URL that made most sense, since users can choose to create the secret wherever they want.	2021-09-03 16:40:59 +00:00
Gregor MartynusandGitHub	b4200b05cd	ci(test): set node version explicitly in `test` job (#2092 )	2021-08-25 12:14:40 -07:00
Matt TraviandGitHub	ea52e1775a	fix(engines): fixed defined node version to account for the higher requirement from the npm plugin (#2088 )	2021-08-25 12:01:16 -07:00
Matt TraviandGitHub	5edff69580	fix(marked): reverted upgrade to v3 (#2087 ) since marked v3 requires node v12	2021-08-23 15:34:58 -05:00
renovate[bot]GitHub Renovate Bot	6e4beb8314	fix(deps): update dependency marked to v3 Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-08-15 22:58:06 -07:00
renovate[bot]GitHub Renovate Bot	ebad322318	chore(deps): update dependency path-parse to 1.0.7 [security] (#2072 ) Co-authored-by: Renovate Bot <bot@renovateapp.com>	2021-08-11 23:11:48 -05:00