From d4520e10ed8d36e7ab56b1e3bd36761f7f90fae0 Mon Sep 17 00:00:00 2001 From: Johannes Klein Date: Tue, 4 Jun 2019 22:44:08 +0200 Subject: [PATCH] doc: add info about default plugins --- docs/usage/plugins.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/docs/usage/plugins.md b/docs/usage/plugins.md index a1f792ab..43875f3a 100644 --- a/docs/usage/plugins.md +++ b/docs/usage/plugins.md @@ -17,15 +17,26 @@ A plugin is a npm module that can implement one or more of the following steps: **Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used. -See [available plugins](../extending/plugins-list.md). +## Plugins installation + +These five plugins are already part of **semantic-release** and don't have to be installed separately: +``` +"@semantic-release/commit-analyzer" +"@semantic-release/error" +"@semantic-release/github" +"@semantic-release/npm" +"@semantic-release/release-notes-generator" +``` + +[Additional plugins](../extending/plugins-list.md) have to be installed via npm: + +```bash +$ npm install @semantic-release/git @semantic-release/changelog -D +``` ## Plugins configuration -Each plugin must be installed and configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name. - -```bash -$ npm install @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/npm -D -``` +Each plugin must be configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name. ```json {