actions/version-increment
1
Fork 0
mirror of https://github.com/reecetech/version-increment.git synced 2025-12-21 14:35:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Phil Jay
2023-09-16 10:06:06 +10:00
parent 0974302def
commit 2ef15157dd
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -81,11 +81,12 @@ Examples:
### 📥 Inputs ### 📥 Inputs
| name | description | required | default | | name | description | required | default |
| :--- | :--- | :--- | :--- | | :--- | :--- | :--- | :--- |
| scheme | The versioning scheme in-use, either `semver` or `calver` | No | `semver` | | scheme | The versioning scheme in-use, either `semver` or `calver` | No | `semver` |
| pep440 | Set to `true` for PEP440 compatibility of _pre-release_ versions by making use of the build metadata segment of semver, which maps to local version identifier in PEP440 | No | `false` | | pep440 | Set to `true` for PEP440 compatibility of _pre-release_ versions by making use of the build metadata segment of semver, which maps to local version identifier in PEP440 | No | `false` |
| increment | The digit to increment, either `major`, `minor` or `patch`, ignored if `scheme` == `calver` | No | `patch` | | increment | The digit to increment, either `major`, `minor` or `patch`, ignored if `scheme` == `calver` | No | `patch` |
| release_branch | Specify a non-default branch to use for the release tag (the one without -pre) | No | |
### 📤 Outputs ### 📤 Outputs

2
action.yml
View File

@@ -23,7 +23,7 @@ inputs:
required: false required: false
default: 'patch' default: 'patch'
release_branch: release_branch:
description: "Specify a non-main branch to use for the release tag (the one without -prerelease). If empty, will use the default branch for the repo." description: 'Specify a non-default branch to use for the release tag (the one without -pre)'
required: false required: false
type: string type: string