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

docs: tag_format parameter

Browse source
This commit is contained in:
Joel Humberto Gomez Paredes 2023-03-05 02:31:53 -06:00
parent a1673fc63d
commit 6c71439622
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -52,6 +52,7 @@ then make sure that you configure this in your `package.json` file:
| dry_run | false | Whether to run semantic release in `dry-run` mode. [[Details](#dry_run)] |
| extends | false | Use a sharable configuration [[Details](#extends)] |
| working_directory | false | Use another working directory for semantic release [[Details](#working_directory)] |
| tag_format | false | Specify format of tag (useful for monorepos) |
#### semantic_version
> {Optional Input Parameter} Specify version range for semantic-release.
@ -229,6 +230,22 @@ steps:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
#### tag_format
The default tag format on semantic-release is `v{version}`. You can override that behavior using this option (helpful when you are using monorepos)
```yaml
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v3
with:
tag_format: custom-v{version}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
### Outputs
| Output Parameter | Description |
|:-------------------------:|-----------------------------------------------------------------------------------------------------------------------------------|