Merge pull request #23 from ps-jay/main

Introduce test for `release_branch`, & update README

README.md

@@ -81,11 +81,12 @@ Examples:
 
 ### 📥 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
 

action.yml

@@ -22,6 +22,10 @@ inputs:
       Not applicable to `calver` scheme
     required: false
     default: 'patch'
+  release_branch:
+    description: 'Specify a non-default branch to use for the release tag (the one without -pre)'
+    required: false
+    type: string
 
 outputs:
   current-version:
@@ -75,3 +79,4 @@ runs:
         increment: ${{ inputs.increment }}
         pep440: ${{ inputs.pep440 }}
         scheme: ${{ inputs.scheme }}
+        release_branch: ${{ inputs.release_branch }}

tests/test_version-increment.bats

@@ -224,6 +224,22 @@ function init_repo {
     [[ "$output" = *"VERSION=1.2.4-pre.${short_ref}"* ]]
 }
 
+@test "does not append prerelease information if on a specified release_branch" {
+    init_repo
+
+    export current_version=1.2.3
+    export GITHUB_REF="refs/heads/releases"
+    export release_branch="releases"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" != *"PRE_RELEASE_LABEL=pre."* ]] &&
+    [[ "$output" != *"VERSION=1.2.4-pre."* ]] &&
+    [[ "$output" = *"VERSION=1.2.4"* ]]
+}
+
 @test "appends prerelease information in pep440 compatible way when pep440 is true" {
     init_repo
 

version-increment.sh

@@ -32,6 +32,11 @@ default_branch='main'
 if [[ -z "${BATS_VERSION:-}" ]] ; then
     default_branch="$(git remote show origin | ${grep} 'HEAD branch' | cut -d ' ' -f 5)"
 fi
+# use release_branch if not empty
+if [[ -n "${release_branch:-}" ]] ; then
+    default_branch="${release_branch}" 
+fi
+
 current_ref="${GITHUB_REF:-}"
 git_commit="$(git rev-parse --short HEAD | sed 's/0*//')"  # trim leading zeros, because semver doesn't allow that in
                                                            # the 'pre-release version' part, but we can't use the + char