From 2ef15157ddb6f58ce6347d693cfcf866bd08e6f8 Mon Sep 17 00:00:00 2001 From: Phil Jay Date: Sat, 16 Sep 2023 10:06:06 +1000 Subject: [PATCH] Update README --- README.md | 11 ++++++----- action.yml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d35199e..c560b10 100644 --- a/README.md +++ b/README.md @@ -81,11 +81,12 @@ Examples: ### 📥 Inputs -| name | description | required | default | -| :--- | :--- | :--- | :--- | -| 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` | -| increment | The digit to increment, either `major`, `minor` or `patch`, ignored if `scheme` == `calver` | No | `patch` | +| name | description | required | default | +| :--- | :--- | :--- | :--- | +| 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` | +| 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 diff --git a/action.yml b/action.yml index d280373..7b51a8f 100644 --- a/action.yml +++ b/action.yml @@ -23,7 +23,7 @@ inputs: required: false default: 'patch' 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 type: string