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

feat: add a new output - "new-release-published"

Browse source
This commit is contained in:
cycjimmy 2019-10-17 20:33:41 +08:00
parent ddd286be06
commit be8f403201
4 changed files with 71 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2,17 +2,39 @@
GitHub Action for [Semantic Release](https://github.com/semantic-release/semantic-release).
## Usage
* `branch`: [Optional] The branch for release. Default `"master"`.
* `extra_plugins`: [Optional] Extra plugins for pre-install. Default `""`.
* inputs:
* `branch`: [Optional] The branch for release. Default `"master"`.
* `extra_plugins`: [Optional] Extra plugins for pre-install. Default `""`.
* outputs:
* `new-release-published`: Whether a new release was published. `true` or `false`
A simple example
```yaml
steps:
- name: Semantic Release
uses: cycjimmy/semantic-release-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
An advanced example
```yaml
steps:
- name: Semantic Release
uses: cycjimmy/semantic-release-action@master
id: semantic
with:
branch: master
extra_plugins: |
@semantic-release/git
@semantic-release/changelog
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Do something when a new release published
if: steps.semantic.outputs.new-release-published == 'true'
run: ...
```