actions/semantic-release-action
3
0
Fork 0
mirror of https://github.com/cycjimmy/semantic-release-action.git synced 2026-04-15 02:46:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(extra_plugins): improve extra_plugins configuration document(#3)

Browse source
This commit is contained in:
cycjimmy 2019-10-31 22:57:14 +08:00
parent 49e15bd489
commit 56fc83231a
2 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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 }}