From 0f298121cd86d229cb258aab172d99654aa8e421 Mon Sep 17 00:00:00 2001 From: Phil Jay Date: Sat, 31 Aug 2024 14:44:57 +1000 Subject: [PATCH] Update README --- README.md | 29 ++++++++++++++++------------- action.yml | 2 +- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9eeadb7..f434371 100644 --- a/README.md +++ b/README.md @@ -132,22 +132,25 @@ Examples: | 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 | | | use_api | Use the GitHub API to discover current tags, which avoids the need for a git checkout, but requires `curl` and `jq` | No | `false` | +| tag_prefix | Prefix the tag with a string (defaults to empty string). e.g. if set to `@org/product/` the action will filter by this prefix and return `@org/product/1.2.3` in `prefixed-version` output | No | | ### Outputs 📤 -| name | description | -| :--- | :--- | -| current-version | The current latest version detected from the git repositories tags | -| current-v-version | The current latest version detected from the git repositories tags, prefixed with a `v` character | -| version | The incremented version number (e.g. the next version) | -| v-version | The incremented version number (e.g. the next version), prefixed with a `v` character | -| major-version | Major number of the incremented version | -| minor-version | Minor number of the incremented version | -| patch-version | Patch number of the incremented version | -| pre-release-label | Pre-release label of the incremented version | -| major-v-version | Major number of the incremented version, prefixed with a `v` character | -| minor-v-version | Minor number of the incremented version, prefixed with a `v` character | -| patch-v-version | Patch number of the incremented version, prefixed with a `v` character | +| name | description | +| :--- | :--- | +| current-version | The current latest version detected from the git repositories tags | +| current-v-version | The current latest version detected from the git repositories tags, prefixed with a `v` character | +| version | The incremented version number (e.g. the next version) | +| v-version | The incremented version number (e.g. the next version), prefixed with a `v` character | +| major-version | Major number of the incremented version | +| minor-version | Minor number of the incremented version | +| patch-version | Patch number of the incremented version | +| pre-release-label | Pre-release label of the incremented version | +| major-v-version | Major number of the incremented version, prefixed with a `v` character | +| minor-v-version | Minor number of the incremented version, prefixed with a `v` character | +| patch-v-version | Patch number of the incremented version, prefixed with a `v` character | +| prefixed-version | Incremented version calculated, including a `tag_prefix` if specified | +| prefixed-v-version | Incremented version calculated, prefixed with a `v` charatcter, and also including a `tag_prefix` if specified | ## Contributing 💕 diff --git a/action.yml b/action.yml index c6c81a6..994c024 100644 --- a/action.yml +++ b/action.yml @@ -42,7 +42,7 @@ inputs: default: false tag_prefix: description: | - Field to prefix the tag with a string (defaults to empty string). This is useful for projects that use a prefix in their tags. E.g. if set to `@org/product` the action will return `@org/product/1.2.3` as version. + Prefix the tag with a string (defaults to empty string). e.g. if set to `@org/product/` the action will filter by this prefix and return `@org/product/1.2.3` in `prefixed-version` output required: false default: false