From 56fc83231ad58d2ae0829017fb160d1a64d366ea Mon Sep 17 00:00:00 2001
From: cycjimmy <cycjimmy@gmail.com>
Date: Thu, 31 Oct 2019 22:57:14 +0800
Subject: [PATCH] docs(extra_plugins): improve `extra_plugins` configuration
 document(#3)

---
 README.md  | 5 +++--
 action.yml | 2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f84b3d5..901b566 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ GitHub Action for [Semantic Release](https://github.com/semantic-release/semanti
 #### Step3: Add a [Workflow File](https://help.github.com/en/articles/workflow-syntax-for-github-actions) to your repository to create custom automated processes.
 * inputs:
   * `branch`: [Optional] The branch on which releases should happen. It will override the branch attribute in your configuration file. If the attribute is not configured on both sides, the default is master.
-  * `extra_plugins`: [Optional] Extra plugins for pre-install.
+  * `extra_plugins`: [Optional] Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer.
   * `dry_run`: [Optional] Whether to run semantic release in "dry-run" mode. It will override the dryRun attribute in your configuration file.
 * outputs:
   * `new_release_published`: Whether a new release was published. `true` or `false`
@@ -45,9 +45,10 @@ steps:
     id: semantic   # Need an `id` for output variables
     with:
       branch: master
+      # You can specify specifying version range for the extra plugins if you prefer.
       extra_plugins: |
         @semantic-release/git
-        @semantic-release/changelog
+        @semantic-release/changelog@3.0.0
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/action.yml b/action.yml
index b7ee63c..4862c12 100644
--- a/action.yml
+++ b/action.yml
@@ -8,7 +8,7 @@ inputs:
   branch:
     description: 'The branch on which releases should happen. It will override the branch attribute in your configuration file. If the attribute is not configured on both sides, the default is master.'
   extra_plugins:
-    description: 'Extra plugins for pre-install'
+    description: 'Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer.'
   dry_run:
     description: 'Whether to run semantic release in "dry-run" mode. It will override the dryRun attribute in your configuration file'
 outputs: