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

docs(plugins): clarify order of execution (#1989)

Browse Source
This commit is contained in:
Fernando Rojo 2021-06-25 15:06:57 -04:00 committed by GitHub
parent 80e1665037
commit 1463eb42cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/usage/plugins.md
View File

@ -16,6 +16,8 @@ A plugin is a npm module that can implement one or more of the following steps:
| `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. |
Release steps will run in that order. At each step, **semantic-release** will run every plugin in the [`plugins` array](#plugins-declaration-and-execution-order), as long as the plugin implements the step.
**Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used. **Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used.
## Plugins installation ## Plugins installation
@ -70,6 +72,8 @@ With this configuration **semantic-release** will:
- execute the `prepare` implementation of `@semantic-release/npm` then `@semantic-release/git` - execute the `prepare` implementation of `@semantic-release/npm` then `@semantic-release/git`
- execute the `publish` implementation of `@semantic-release/npm` - execute the `publish` implementation of `@semantic-release/npm`
Order is first determined by release steps (such as `verifyConditions` → `anayzeCommits`). At each release step, plugins are executed in the order in which they are defined.
## Plugin options configuration ## Plugin options configuration
A plugin configuration can be specified by wrapping the name and an options object in an array. Options configured this way will be passed only to that specific plugin. A plugin configuration can be specified by wrapping the name and an options object in an array. Options configured this way will be passed only to that specific plugin.