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

docs: document that plugins config is an override (#1216)

Browse Source 
This patch documents that the `plugin` config option is an override, not
a merge with the default. This is significant, for example, if you
customise the github plugin as it will then prevent npm publishing by
default unless the npm plugin is also defined manually.
This commit is contained in:
Rob Cresswell 2019-06-25 23:01:55 +03:00 committed by Gregor Martynus
parent 01a0b2d08a
commit 228fed7a0b
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/usage/plugins.md
View File

@ -44,6 +44,8 @@ Each plugin must be configured with the [`plugins` options](./configuration.md#p
} }
``` ```
**Note:** If the `plugins` option is defined, it overrides the default plugin list, rather than merging with it.
## Plugin ordering ## Plugin ordering
For each [release step](../../README.md#release-steps) the plugins that implement that step will be executed in the order in which the are defined. For each [release step](../../README.md#release-steps) the plugins that implement that step will be executed in the order in which the are defined.