Merge pull request #9 from reecetech/v-prefix

Add `v` prefixed version output

.github/workflows/test-and-release.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Setup bats
         uses: mig4/setup-bats@af9a00deb21b5d795cabfeaa8d9060410377686d
         with:
-          bats-version: 1.2.1
+          bats-version: 1.4.1
 
       - name: Test
         run: bats tests/*.bats
@@ -52,7 +52,7 @@ jobs:
         run: ./version-increment.sh
         env:
           current_version: ${{ steps.version-lookup.outputs.current-version }}
-          INPUT_SCHEME: calver
+          scheme: calver
 
       - name: Release version
         uses: marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0

README.md

@@ -5,8 +5,11 @@
 ### ⌨️ Example
 
 ```yaml
+      - name: Checkout code
+        uses: actions/checkout@v2
+
       - name: Get next version
-        uses: reecetech/version-increment@2021.10.3
+        uses: reecetech/version-increment@2021.11.2
         id: version
         with:
           scheme: semver
@@ -79,10 +82,12 @@ Examples:
 
 ### 📤 Outputs
 
-| name            | description                                                        |
-| :---            | :---                                                               |
-| current_version | The current latest version detected from the git repositories tags |
-| version         | The incremented version number (e.g. the next version)             |
+| 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             |
 
 ## 💕 Contributing
 

action.yml

@@ -33,9 +33,13 @@ runs:
     - id: version-lookup
       run: ${{ github.action_path }}/version-lookup.sh
       shell: bash
+      env:
+        scheme: ${{ inputs.scheme }}
 
     - id: version-increment
       run: ${{ github.action_path }}/version-increment.sh
       shell: bash
       env:
         current_version: ${{ steps.version-lookup.outputs.current-version }}
+        increment: ${{ inputs.increment }}
+        scheme: ${{ inputs.scheme }}

shared.sh

@@ -2,12 +2,25 @@
 # shellcheck disable=SC2034
 set -euo pipefail
 
-# see: https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+##==----------------------------------------------------------------------------
+##  SemVer regexes
+##  see: https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+
 pcre_semver='^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$'
 pcre_master_ver='^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)$'
 pcre_allow_vprefix="^v{0,1}${pcre_master_ver:1}"
 pcre_old_calver='^(?P<major>0|[1-9]\d*)-0{0,1}(?P<minor>0|[0-9]\d*)-R(?P<patch>0|[1-9]\d*)$'
 
+##==----------------------------------------------------------------------------
+##  Input validation
+
+input_errors='false'
+scheme="${scheme:-semver}"
+if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
+    echo "🛑 Value of 'scheme' is not valid, choose from 'semver' or 'calver'" 1>&2
+    input_errors='true'
+fi
+
 ##==----------------------------------------------------------------------------
 ##  MacOS compatibility - for local testing
 

tests/test_version-increment.bats

@@ -25,7 +25,7 @@ function init_repo {
     run ../../version-increment.sh
 
     print_run_info
-    [ "$status" -eq 5 ] &&
+    [ "$status" -eq 8 ] &&
     [[ "$output" = *"Environment variable 'current_version' is unset or empty"* ]]
 }
 
@@ -37,15 +37,14 @@ function init_repo {
     run ../../version-increment.sh
 
     print_run_info
-    [ "$status" -eq 6 ] &&
+    [ "$status" -eq 8 ] &&
     [[ "$output" = *"Environment variable 'current_version' is not a valid normal version"* ]]
 }
 
 @test "fails if invalid scheme given" {
     init_repo
 
-    export current_version=1.2.3
-    export INPUT_SCHEME="foover"
+    export scheme="foover"
 
     run ../../version-increment.sh
 
@@ -57,13 +56,12 @@ function init_repo {
 @test "fails if invalid increment given" {
     init_repo
 
-    export current_version=1.2.3
-    export INPUT_INCREMENT="critical"
+    export increment="critical"
 
     run ../../version-increment.sh
 
     print_run_info
-    [ "$status" -eq 7 ] &&
+    [ "$status" -eq 8 ] &&
     [[ "$output" = *"Value of 'increment' is not valid, choose from 'major', 'minor', or 'patch'"* ]]
 }
 
@@ -71,7 +69,7 @@ function init_repo {
     init_repo
 
     export current_version=1.2.3
-    export INPUT_INCREMENT="patch"
+    export increment="patch"
 
     run ../../version-increment.sh
 
@@ -84,7 +82,7 @@ function init_repo {
     init_repo
 
     export current_version=1.2.3
-    export INPUT_INCREMENT="minor"
+    export increment="minor"
 
     run ../../version-increment.sh
 
@@ -97,7 +95,7 @@ function init_repo {
     init_repo
 
     export current_version=1.2.3
-    export INPUT_INCREMENT="major"
+    export increment="major"
 
     run ../../version-increment.sh
 
@@ -106,11 +104,25 @@ function init_repo {
     [[ "$output" = *"::set-output name=version::2.0.0"* ]]
 }
 
+@test "prefixes with v" {
+    init_repo
+
+    export current_version=1.2.3
+    export increment="major"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"::set-output name=version::2.0.0"* ]] &&
+    [[ "$output" = *"::set-output name=v-version::v2.0.0"* ]]
+}
+
 @test "increments to a new month (calver)" {
     init_repo
 
     export current_version=2020.6.4
-    export INPUT_SCHEME="calver"
+    export scheme="calver"
 
     run ../../version-increment.sh
 
@@ -123,7 +135,7 @@ function init_repo {
     init_repo
 
     export current_version="$(date +%Y.%-m.123)"
-    export INPUT_SCHEME="calver"
+    export scheme="calver"
 
     run ../../version-increment.sh
 

tests/test_version-lookup.bats

@@ -20,7 +20,7 @@ function init_repo {
 @test "fails if invalid scheme given" {
     init_repo
 
-    export INPUT_SCHEME="foover"
+    export scheme="foover"
 
     run ../../version-lookup.sh
 
@@ -43,6 +43,19 @@ function init_repo {
     [[ "$output" = *"::set-output name=current-version::0.1.2"* ]]
 }
 
+@test "prefixes with a v" {
+    init_repo
+
+    git tag 0.1.2
+
+    run ../../version-lookup.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"::set-output name=current-version::0.1.2"* ]] &&
+    [[ "$output" = *"::set-output name=current-v-version::v0.1.2"* ]]
+}
+
 @test "finds the current normal version even if there's a newer pre-release version" {
     init_repo
 
@@ -81,7 +94,7 @@ function init_repo {
 @test "returns a calver if no normal version detected and calver scheme specified" {
     init_repo
 
-    export INPUT_SCHEME="calver"
+    export scheme="calver"
 
     run ../../version-lookup.sh
 

version-increment.sh

@@ -6,25 +6,21 @@ script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 # shellcheck source=shared.sh
 source "${script_dir}/shared.sh"
 
-if [[ -z "${current_version:-}" ]] ; then
-    echo "🛑 Environment variable 'current_version' is unset or empty" 1>&2
-    exit 5
-fi
-
-if [[ -z "$(echo "${current_version}" | ${grep} -P "${pcre_master_ver}")" ]] ; then
-    echo "🛑 Environment variable 'current_version' is not a valid normal version (M.m.p)" 1>&2
-    exit 6
-fi
-
-increment="${INPUT_INCREMENT:-patch}"
+increment="${increment:-patch}"
 if [[ "${increment}" != 'patch' && "${increment}" != 'minor' && "${increment}" != 'major' ]] ; then
     echo "🛑 Value of 'increment' is not valid, choose from 'major', 'minor', or 'patch'" 1>&2
-    exit 7
+    input_errors='true'
 fi
 
-scheme="${INPUT_SCHEME:-semver}"
-if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
-    echo "🛑 Value of 'scheme' is not valid, choose from 'semver' or 'calver'" 1>&2
+if [[ -z "${current_version:-}" ]] ; then
+    echo "🛑 Environment variable 'current_version' is unset or empty" 1>&2
+    input_errors='true'
+elif [[ -z "$(echo "${current_version}" | ${grep} -P "${pcre_master_ver}")" ]] ; then
+    echo "🛑 Environment variable 'current_version' is not a valid normal version (M.m.p)" 1>&2
+    input_errors='true'
+fi
+
+if [[ "${input_errors}" == 'true' ]] ; then
     exit 8
 fi
 
@@ -91,3 +87,4 @@ fi
 echo "ℹ️ The new version is ${new_version}"
 
 echo "::set-output name=version::${new_version}"
+echo "::set-output name=v-version::v${new_version}"

version-lookup.sh

@@ -6,9 +6,7 @@ script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 # shellcheck source=shared.sh
 source "${script_dir}/shared.sh"
 
-scheme="${INPUT_SCHEME:-semver}"
-if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
-    echo "🛑 Value of 'scheme' is not valid, choose from 'semver' or 'calver'" 1>&2
+if [[ "${input_errors}" == 'true' ]] ; then
     exit 8
 fi
 
@@ -64,3 +62,4 @@ fi
 echo "ℹ️ The current normal version is ${current_version}"
 
 echo "::set-output name=current-version::${current_version}"
+echo "::set-output name=current-v-version::v${current_version}"