actions/semantic-release-action
5
0
Fork 0
mirror of https://github.com/cycjimmy/semantic-release-action.git synced 2025-11-07 18:56:56 +00:00
Code Activity Actions

docs(README): update semantic_version description

Browse source 
Update the instructions for using the semantic_version parameter
Describe the current incompatibility with semantic-release v20

closes #148
This commit is contained in:
Mike McCready 2023-02-06 08:46:16 +01:00
parent 56bb7f907a
commit e3d9ccfb4a
1 changed files with 25 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -45,7 +45,7 @@ then make sure that you configure this in your `package.json` file:
### Inputs
| Input Parameter | Required | Description |
|:-----------------:|:--------:|--------------------------------------------------------------------------------------------------------------------------|
| semantic_version | false | Specify specifying version range for semantic-release. [[Details](#semantic_version)] |
| semantic_version | false | Specify version range for semantic-release. [[Details](#semantic_version)] |
| branches | false | The branches on which releases should happen.[[Details](#branches)]<br>Support for **semantic-release above v16**. |
| branch | false | The branch on which releases should happen.[[Details](#branch)]<br>Only support for **semantic-release older than v16**. |
| extra_plugins | false | Extra plugins for pre-install. [[Details](#extra_plugins)] |
@ -54,7 +54,7 @@ then make sure that you configure this in your `package.json` file:
| working_directory | false | Use another working directory for semantic release [[Details](#working_directory)] |
#### semantic_version
> {Optional Input Parameter} Specify specifying version range for semantic-release.<br>If no version range is specified, latest version will be used by default.
> {Optional Input Parameter} Specify version range for semantic-release.
```yaml
steps:
@ -63,14 +63,17 @@ steps:
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v3
with:
semantic_version: 15.13.28 # It is recommended to specify specifying version range
# for semantic-release.
semantic_version: 19.0.5 # It is recommended to specify a version range
# for semantic-release when using
# semantic-release-action lower than @v3
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
*It is recommended to manually specify a version of semantic-release to prevent errors caused during the official semantic-release upgrade.*
If no version range is specified with `cycjimmy/semantic-release-action@v3` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [19.0.5](https://github.com/semantic-release/semantic-release/releases/tag/v19.0.5) is used. Earlier versions of `cycjimmy/semantic-release-action` default to using the latest version of [semantic-release](https://github.com/semantic-release/semantic-release/), so in this case it is recommended to specify version 19 or lower to avoid compatibility issues.
*Note: [Version 20.0.0](https://github.com/semantic-release/semantic-release/releases/tag/v20.0.0) of [semantic-release](https://github.com/semantic-release/semantic-release/) and later is currently incompatible with `cycjimmy/semantic-release-action`, since it requires Node.js 18. GitHub does not provide this environment yet [for JavaScript actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions).*
#### branches
> {Optional Input Parameter} The branches on which releases should happen.<br>`branches` supports for **semantic-release above v16**.
@ -128,7 +131,7 @@ steps:
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v3
with:
semantic_version: 15.13.28
semantic_version: 19.0.5
# you can set branch for semantic-release older than v16.
branch: your-branch
env: