simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(plugins): document addChannel step (#1721)

Browse Source 
Document the `addChannel` step defined in
e35e5bb73f/lib/definitions/plugins.js (L83-L84),
which is used in @semantic-release/npm.
This commit is contained in:
cherryblossom000 2020-12-30 07:33:12 +11:00 committed by GitHub
parent 52238cbccc
commit e211499735
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/usage/plugins.md
View File

@ -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. | | `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. | | `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. | | `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. | | `success` | No | Responsible for notifying of a new release. |
| `fail` | No | Responsible for notifying of a failed release. | | `fail` | No | Responsible for notifying of a failed release. |