From e211499735a3fc98a73d1815019bab3c5a34d278 Mon Sep 17 00:00:00 2001 From: cherryblossom000 <31467609+cherryblossom000@users.noreply.github.com> Date: Wed, 30 Dec 2020 07:33:12 +1100 Subject: [PATCH] docs(plugins): document `addChannel` step (#1721) Document the `addChannel` step defined in https://github.com/semantic-release/semantic-release/blob/e35e5bb73f3628906553709ac0f5beb8f565c61a/lib/definitions/plugins.js#L83-L84, which is used in @semantic-release/npm. --- docs/usage/plugins.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/usage/plugins.md b/docs/usage/plugins.md index 2048e24a..ec9d5b3f 100644 --- a/docs/usage/plugins.md +++ b/docs/usage/plugins.md @@ -12,6 +12,7 @@ A plugin is a npm module that can implement one or more of the following steps: | `generateNotes` | No | Responsible for generating the content of the release note. If multiple plugins with a `generateNotes` step are defined, the release notes will be the result of the concatenation of each plugin output. | | `prepare` | No | Responsible for preparing the release, for example creating or updating files such as `package.json`, `CHANGELOG.md`, documentation or compiled assets and pushing a commit. | | `publish` | No | Responsible for publishing the release. | +| `addChannel` | No | Responsible for adding a release channel (e.g. adding an npm dist-tag to a release). | | `success` | No | Responsible for notifying of a new release. | | `fail` | No | Responsible for notifying of a failed release. |