From 228fed7a0b7cfd19f762eb6f033ed165509db342 Mon Sep 17 00:00:00 2001 From: Rob Cresswell Date: Tue, 25 Jun 2019 23:01:55 +0300 Subject: [PATCH] docs: document that plugins config is an override (#1216) 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. --- docs/usage/plugins.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/usage/plugins.md b/docs/usage/plugins.md index 43875f3a80..f7b82f2ab3 100644 --- a/docs/usage/plugins.md +++ b/docs/usage/plugins.md @@ -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 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.