docs: reorder default plugins list #1650
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Reorder the list of default plugins in the documentation from alphabetical to execution order.
Motivation
The documentation clearly states the four default plugins that are already installed with semantic-release. However their default order of execution is not explicitly stated and when listed in alphabetical order implies the incorrect order.
When a package maintainer needs to configure options on one or more default plugins the documentation states that the
plugins
property will be overridden instead of merged.For that reason the maintainer must add all default plugins to the configuration list to modify the configuration of a single plugin. When looking at the documentation it is easy to find the default list of plugins but not so easy to find the default order in which the plugins must be listed. Personally, I made the mistake of assuming the order in which they are listed would be the order in which they would execute and modified my
.releaserc
to be:Obviously, this changes the behaviour of the default release because
@semantic-release/github
had switched places with@semantic-release/release-notes-generator
.Solution
This is simply a user vs documentation problem and can be prevented in the future by explicitly stating the order in which plugins are listed. Furthermore, by changing the order from alphabetical to order of execution the user doesn't need to search the codebase to find the correct order.