Merge pull request #25 from reecetech/update-shellcheck-action

Update shellcheck action

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

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Run ShellCheck
-        uses: ludeeus/action-shellcheck@94e0aab03ca135d11a35e5bfc14e6746dc56e7e9
+        uses: ludeeus/action-shellcheck@2.0.0
         with:
           check_together: 'yes'
 
@@ -24,12 +24,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup bats
-        uses: mig4/setup-bats@af9a00deb21b5d795cabfeaa8d9060410377686d
+        uses: mig4/setup-bats@af9a00deb21b5d795cabfeaa8d9060410377686d  # v1.2.0
         with:
-          bats-version: 1.2.1
+          bats-version: 1.8.0
 
       - name: Test
         run: bats tests/*.bats
@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Lookup version
         id: version-lookup
@@ -51,14 +51,13 @@ jobs:
         id: version-increment
         run: ./version-increment.sh
         env:
-          current_version: ${{ steps.version-lookup.outputs.current-version }}
+          current_version: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
-          INPUT_SCHEME: calver
+          scheme: calver
 
       - name: Release version
-        uses: marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0
+        uses: softprops/action-gh-release@v1
-        if: ${{ github.ref == 'refs/heads/main' }}
+        if: ${{ github.ref_name == github.event.repository.default_branch }}
         with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
           draft: false
           prerelease: false
-          automatic_release_tag: "${{ steps.version-increment.outputs.version }}"
+          tag_name: "${{ steps.version-increment.outputs.VERSION }}"

README.md

@@ -5,8 +5,11 @@
 ### ⌨️ Example
 
 ```yaml
+      - name: Checkout code
+        uses: actions/checkout@v2
+
       - name: Get next version
-        uses: reecetech/version-increment
+        uses: reecetech/version-increment@2023.9.3
         id: version
         with:
           scheme: semver
@@ -21,6 +24,7 @@
 ```
 
 ### 🔖 semver
+
 This action will detect the current latest _normal_ semantic version (semver) from the tags in
 a git repository.  It will increment the version as directed (by default: +1 to
 the patch digit).  Both the current latest and the incremented version are
@@ -49,14 +53,16 @@ e.g. `2021.6.2`
 | minor  | month   | `6`     |
 | patch  | release | `2`     | The *n*th release for the month |
 
-If the current latest normal version is not the current year and month, then the year and month digits will be
+If the current latest normal version is not the current year and month, then the
+year and month digits will be
 set to the current year and month, and the release digit will be reset to 1.
 
 ### 🎋 Default branch vs. any other branch
 
 **Default branch**
 
-The action will return a _normal_ version if it is detected that the current commit is on the default branch (usually `main`).
+The action will return a _normal_ version if it is detected that the current commit
+is on the default branch (usually `main`).
 
 Examples:
 * `1.2.7`
@@ -64,7 +70,10 @@ Examples:
 
 **Any other branch**
 
-The action will return a _pre-release_ version if any other branch is detected (e.g. `new-feature`, `bugfix/foo`, etc).  The _pre-release_ portion of the version number will be the literal string `pre.` followed by the git commit ID short reference SHA (trimmed of any leading zeros).
+The action will return a _pre-release_ version if any other branch is detected
+(e.g. `new-feature`, `bugfix/foo`, etc).  The _pre-release_ portion of the version number
+will be the literal string `pre.` followed by the git commit ID short reference SHA
+(trimmed of any leading zeros).
 
 Examples:
 * `1.2.7-pre.41218aa78`
@@ -72,17 +81,28 @@ 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` |
-| increment | The digit to increment, either `major`, `minor` or `patch`, ignored if `scheme` == `calver` | No | `patch` |
+| 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
 
-| name            | description                                                        |
+| name              | description                                                                                       |
-| :---            | :---                                                               |
+| :---              | :---                                                                                              |
-| current_version | The current latest version detected from the git repositories tags |
+| current-version   | The current latest version detected from the git repositories tags                                |
-| version         | The incremented version number (e.g. the next version)             |
+| 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                            |
 
 ## 💕 Contributing
 

action.yml

@@ -1,17 +1,20 @@
 ---
 name: 'Version Increment'
-description: |
+description: Inspects the git tags to determine the current normal version, and returns the next version number
-  Inspects the git tags to determine the current normal version, and returns the
-  next version number.
 
-  A normal version will be returned if the branch is the default branch
+branding:
-  (usually `main`), otherwise a pre-release version will be returned.
+  icon: plus
+  color: purple
 
 inputs:
   scheme:
     description: 'Versioning scheme - semver, or, calver (defaults to semver)'
     required: false
     default: 'semver'
+  pep440:
+    description: 'PEP440 compatibility mode - shifts the pre-release version information into build metadata instead'
+    required: false
+    default: false
   increment:
     description: |
       Field to increment - major, minor, or, patch (defaults to patch)
@@ -19,14 +22,45 @@ 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:
+  current-version:
     description: 'Current normal version detected'
-    value: ${{ steps.version-lookup.outputs.current-version }}
+    value: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
+  current-v-version:
+    description: 'Current normal version detected, prefixed with a `v` charatcter'
+    value: ${{ steps.version-lookup.outputs.CURRENT_V_VERSION }}
   version:
     description: 'Incremented version calculated'
-    value: ${{ steps.version-increment.outputs.version }}
+    value: ${{ steps.version-increment.outputs.VERSION }}
+  v-version:
+    description: 'Incremented version calculated, prefixed with a `v` charatcter'
+    value: ${{ steps.version-increment.outputs.V_VERSION }}  
+  major-version:
+    description: 'Major number of the incremented version'
+    value: ${{ steps.version-increment.outputs.MAJOR_VERSION }}
+  minor-version:
+    description: 'Minor number of the incremented version'
+    value: ${{ steps.version-increment.outputs.MINOR_VERSION }}
+  patch-version:
+    description: 'Patch number of the incremented version'
+    value: ${{ steps.version-increment.outputs.PATCH_VERSION }}
+  pre-release-label:
+    description: 'Pre-release label of the incremented version'
+    value: ${{ steps.version-increment.outputs.PRE_RELEASE_LABEL }}
+  major-v-version:
+    description: 'Major number of the incremented version, prefixed with a `v` charatcter'
+    value: ${{ steps.version-increment.outputs.MAJOR_V_VERSION }}
+  minor-v-version:
+    description: 'Minor number of the incremented version, prefixed with a `v` charatcter'
+    value: ${{ steps.version-increment.outputs.MINOR_V_VERSION }}
+  patch-v-version:
+    description: 'Patch number of the incremented version, prefixed with a `v` charatcter'
+    value: ${{ steps.version-increment.outputs.PATCH_V_VERSION }}
 
 runs:
   using: "composite"
@@ -34,9 +68,15 @@ 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
-      with:
+      env:
-        current_version: ${{ steps.version-lookup.outputs.current-version }}
+        current_version: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
+        increment: ${{ inputs.increment }}
+        pep440: ${{ inputs.pep440 }}
+        scheme: ${{ inputs.scheme }}
+        release_branch: ${{ inputs.release_branch }}

shared.sh

@@ -2,12 +2,31 @@
 # 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
+
+pep440="${pep440:-false}"
+if [[ "${pep440}" != 'false' && "${pep440}" != 'true' ]] ; then
+    echo "🛑 Value of 'pep440' is not valid, choose from 'false' or 'true'" 1>&2
+    input_errors='true'
+fi
+
 ##==----------------------------------------------------------------------------
 ##  MacOS compatibility - for local testing
 
@@ -19,3 +38,10 @@ if [[ "$(uname)" == "Darwin" ]] ; then
         exit 9
     fi
 fi
+
+##==----------------------------------------------------------------------------
+##  Non GitHub compatibility - for testing both locally and in BATS
+
+if [[ -z "${GITHUB_OUTPUT:-}" || -n "${BATS_VERSION:-}" ]] ; then
+    export GITHUB_OUTPUT="/dev/stdout"
+fi

tests/test_version-increment.bats

@@ -0,0 +1,274 @@
+#!/usr/bin/env bats
+# vim: set ft=sh sw=4 :
+
+load helper_print-info
+
+export repo=".tmp_testing/repo"
+
+function init_repo {
+    rm -rf "${repo}" &&
+    mkdir -p "${repo}" &&
+    cd "${repo}" &&
+    git init &&
+    git checkout -b main &&
+    touch README.md &&
+    git add README.md &&
+    git config user.email test@example.com &&
+    git config user.name Tester &&
+    git commit -m "README" &&
+    export GITHUB_REF="refs/heads/main"
+}
+
+@test "fails if no current_version given" {
+    init_repo
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 8 ] &&
+    [[ "$output" = *"Environment variable 'current_version' is unset or empty"* ]]
+}
+
+@test "fails if invalid current_version given" {
+    init_repo
+
+    export current_version=1.3.5-prerelease
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 8 ] &&
+    [[ "$output" = *"Environment variable 'current_version' is not a valid normal version"* ]]
+}
+
+@test "fails if invalid scheme given" {
+    init_repo
+
+    export scheme="foover"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 8 ] &&
+    [[ "$output" = *"Value of 'scheme' is not valid"* ]]
+}
+
+@test "fails if invalid value for pep440 given" {
+    init_repo
+
+    export pep440="yes"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 8 ] &&
+    [[ "$output" = *"Value of 'pep440' is not valid"* ]]
+}
+
+@test "fails if invalid increment given" {
+    init_repo
+
+    export increment="critical"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 8 ] &&
+    [[ "$output" = *"Value of 'increment' is not valid, choose from 'major', 'minor', or 'patch'"* ]]
+}
+
+@test "no deprecated set-output calls made" {
+    run grep -q "::set-output" version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 1 ]
+}
+
+@test "increments the patch digit correctly (semver)" {
+    init_repo
+
+    export current_version=1.2.3
+    export increment="patch"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"MAJOR_VERSION=1"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=2"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=4"* ]] &&
+    [[ "$output" = *"VERSION=1.2.4"* ]]
+}
+
+@test "increments the minor digit correctly (semver)" {
+    init_repo
+
+    export current_version=1.2.3
+    export increment="minor"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"MAJOR_VERSION=1"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=3"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=0"* ]] &&
+    [[ "$output" = *"VERSION=1.3.0"* ]]
+}
+
+@test "increments the minor digit correctly (explicitly not pep440)" {
+    init_repo
+
+    export current_version=1.2.3
+    export pep404="false"
+    export increment="minor"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"MAJOR_VERSION=1"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=3"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=0"* ]] &&
+    [[ "$output" = *"VERSION=1.3.0"* ]]
+}
+
+@test "increments the major digit correctly (semver)" {
+    init_repo
+
+    export current_version=1.2.3
+    export increment="major"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"MAJOR_VERSION=2"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=0"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=0"* ]] &&
+    [[ "$output" = *"VERSION=2.0.0"* ]]
+}
+
+@test "increments the major digit correctly (pep440 mode)" {
+    init_repo
+
+    export current_version=1.2.3
+    export pep404="true"
+    export increment="major"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"MAJOR_VERSION=2"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=0"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=0"* ]] &&
+    [[ "$output" = *"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" = *"VERSION=2.0.0"* ]] &&
+    [[ "$output" = *"MAJOR_V_VERSION=v2"* ]] &&
+    [[ "$output" = *"MINOR_V_VERSION=v0"* ]] &&
+    [[ "$output" = *"PATCH_V_VERSION=v0"* ]] &&
+    [[ "$output" = *"V_VERSION=v2.0.0"* ]]
+}
+
+@test "increments to a new month (calver)" {
+    init_repo
+
+    export current_version=2020.6.4
+    export scheme="calver"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=$(date +%Y.%-m.1)"* ]]
+}
+
+@test "increments the patch digit within a month (calver)" {
+    init_repo
+
+    export current_version="$(date +%Y.%-m.123)"
+    export scheme="calver"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=$(date +%Y.%-m.124)"* ]]
+}
+
+@test "appends prerelease information if on a branch" {
+    init_repo
+
+    export current_version=1.2.3
+    export GITHUB_REF="refs/heads/super-awesome-feature"
+    export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"PRE_RELEASE_LABEL=pre.${short_ref}"* ]] &&
+    [[ "$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
+
+    export current_version=10.20.30
+    export pep440="true"
+    export GITHUB_REF="refs/heads/super-awesome-python"
+    export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"PRE_RELEASE_LABEL=pre.${short_ref}"* ]] &&
+    [[ "$output" = *"VERSION=10.20.31+pre.${short_ref}"* ]]
+}
+
+@test "appends prerelease information in pep440 compatible way when pep440 is true, and using calver scheme" {
+    init_repo
+
+    export current_version=2020.6.4
+    export scheme="calver"
+    export pep440="true"
+    export GITHUB_REF="refs/heads/super-awesome-python"
+    export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"PRE_RELEASE_LABEL=pre.${short_ref}"* ]] &&
+    [[ "$output" = *"VERSION=$(date +%Y.%-m.1)+pre.${short_ref}"* ]]
+}

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
 
@@ -29,6 +29,13 @@ function init_repo {
     [[ "$output" = *"Value of 'scheme' is not valid"* ]]
 }
 
+@test "no deprecated set-output calls made" {
+    run grep -q "::set-output" version-lookup.sh
+
+    print_run_info
+    [ "$status" -eq 1 ]
+}
+
 @test "finds the current normal version" {
     init_repo
 
@@ -40,7 +47,20 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::0.1.2"* ]]
+    [[ "$output" = *"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" = *"CURRENT_VERSION=0.1.2"* ]] &&
+    [[ "$output" = *"CURRENT_V_VERSION=v0.1.2"* ]]
 }
 
 @test "finds the current normal version even if there's a newer pre-release version" {
@@ -53,7 +73,7 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::1.2.300"* ]]
+    [[ "$output" = *"CURRENT_VERSION=1.2.300"* ]]
 }
 
 @test "returns 0.0.0 if no normal version detected" {
@@ -63,7 +83,7 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::0.0.0"* ]]
+    [[ "$output" = *"CURRENT_VERSION=0.0.0"* ]]
 }
 
 @test "returns 0.0.0 if no normal version detected even if there's a pre-release version" {
@@ -75,19 +95,19 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::0.0.0"* ]]
+    [[ "$output" = *"CURRENT_VERSION=0.0.0"* ]]
 }
 
 @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
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::$(date '+%Y.%-m.0')"* ]]
+    [[ "$output" = *"CURRENT_VERSION=$(date '+%Y.%-m.0')"* ]]
 }
 
 @test "converts from older calver scheme automatically" {
@@ -99,7 +119,7 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::2020.9.2"* ]]
+    [[ "$output" = *"CURRENT_VERSION=2020.9.2"* ]]
 }
 
 @test "strips v from the version" {
@@ -111,5 +131,5 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::3.4.5"* ]]
+    [[ "$output" = *"CURRENT_VERSION=3.4.5"* ]]
 }

tests/test_version_increment.bats

@@ -1,147 +0,0 @@
-#!/usr/bin/env bats
-# vim: set ft=sh sw=4 :
-
-load helper_print-info
-
-export repo=".tmp_testing/repo"
-
-function init_repo {
-    rm -rf "${repo}" &&
-    mkdir -p "${repo}" &&
-    cd "${repo}" &&
-    git init &&
-    git checkout -b main &&
-    touch README.md &&
-    git add README.md &&
-    git config user.email test@example.com &&
-    git config user.name Tester &&
-    git commit -m "README" &&
-    export GITHUB_REF="refs/heads/main"
-}
-
-@test "fails if no current_version given" {
-    init_repo
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 5 ] &&
-    [[ "$output" = *"Environment variable 'current_version' is unset or empty"* ]]
-}
-
-@test "fails if invalid current_version given" {
-    init_repo
-
-    export current_version=1.3.5-prerelease
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 6 ] &&
-    [[ "$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"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 8 ] &&
-    [[ "$output" = *"Value of 'scheme' is not valid"* ]]
-}
-
-@test "fails if invalid increment given" {
-    init_repo
-
-    export current_version=1.2.3
-    export INPUT_INCREMENT="critical"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 7 ] &&
-    [[ "$output" = *"Value of 'increment' is not valid, choose from 'major', 'minor', or 'patch'"* ]]
-}
-
-@test "increments the patch digit correctly (semver)" {
-    init_repo
-
-    export current_version=1.2.3
-    export INPUT_INCREMENT="patch"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.2.4"* ]]
-}
-
-@test "increments the minor digit correctly (semver)" {
-    init_repo
-
-    export current_version=1.2.3
-    export INPUT_INCREMENT="minor"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.3.0"* ]]
-}
-
-@test "increments the major digit correctly (semver)" {
-    init_repo
-
-    export current_version=1.2.3
-    export INPUT_INCREMENT="major"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::2.0.0"* ]]
-}
-
-@test "increments to a new month (calver)" {
-    init_repo
-
-    export current_version=2020.6.4
-    export INPUT_SCHEME="calver"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::$(date +%Y.%-m.1)"* ]]
-}
-
-@test "increments the patch digit within a month (calver)" {
-    init_repo
-
-    export current_version="$(date +%Y.%-m.123)"
-    export INPUT_SCHEME="calver"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::$(date +%Y.%-m.124)"* ]]
-}
-
-@test "appends prerelease information if on a branch" {
-    init_repo
-
-    export current_version=1.2.3
-    export GITHUB_REF="refs/heads/super-awesome-feature"
-    export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
-
-    run ../../version-increment.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.2.4-pre.${short_ref}"* ]]
-}

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
+increment="${increment:-patch}"
-    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}"
 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 [[ -z "${current_version:-}" ]] ; then
-if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
+    echo "🛑 Environment variable 'current_version' is unset or empty" 1>&2
-    echo "🛑 Value of 'scheme' is not valid, choose from 'semver' or 'calver'" 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
 
@@ -36,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
@@ -78,7 +79,13 @@ fi
 
 # add pre-release info to version if not the default branch
 if [[ "${current_ref}" != "refs/heads/${default_branch}" ]] ; then
-    new_version="${new_version}-pre.${git_commit}"
+    pre_release="pre.${git_commit}"
+    if [[ "${pep440:-}" == 'true' ]] ; then
+        new_version="${new_version}+${pre_release}"
+    else
+        new_version="${new_version}-${pre_release}"
+    fi
+    echo "PRE_RELEASE_LABEL=${pre_release}" >> "${GITHUB_OUTPUT}"
 fi
 
 if [[ -z "$(echo "${new_version}" | ${grep} -P "${pcre_semver}")" ]] ; then
@@ -90,4 +97,12 @@ fi
 
 echo "ℹ️ The new version is ${new_version}"
 
-echo "::set-output name=version::${new_version}"
+# shellcheck disable=SC2129
+echo "VERSION=${new_version}" >> "${GITHUB_OUTPUT}"
+echo "V_VERSION=v${new_version}" >> "${GITHUB_OUTPUT}"
+echo "MAJOR_VERSION=${version_array[0]}" >> "${GITHUB_OUTPUT}"
+echo "MINOR_VERSION=${version_array[1]}" >> "${GITHUB_OUTPUT}"
+echo "PATCH_VERSION=${version_array[2]}" >> "${GITHUB_OUTPUT}"
+echo "MAJOR_V_VERSION=v${version_array[0]}" >> "${GITHUB_OUTPUT}"
+echo "MINOR_V_VERSION=v${version_array[1]}" >> "${GITHUB_OUTPUT}"
+echo "PATCH_V_VERSION=v${version_array[2]}" >> "${GITHUB_OUTPUT}"

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 [[ "${input_errors}" == 'true' ]] ; then
-if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
-    echo "🛑 Value of 'scheme' is not valid, choose from 'semver' or 'calver'" 1>&2
     exit 8
 fi
 
@@ -29,18 +27,18 @@ fi
 
 # Skip if testing, otherwise pull tags
 if [[ -z "${BATS_VERSION:-}" ]] ; then
-    git fetch --quiet origin 'refs/tags/*:refs/tags/*'
+    git fetch --quiet --force origin 'refs/tags/*:refs/tags/*'
 fi
 
 ##==----------------------------------------------------------------------------
 ##  Version parsing
 
 # detect current version - removing "v" from start of tag if it exists
-current_version="$(git tag -l | { ${grep} -P "${pcre_allow_vprefix}" || true; } | sed 's/^v//g' | sort -V --reverse | head -n1)"
+current_version="$(git tag -l | { ${grep} -P "${pcre_allow_vprefix}" || true; } | sed 's/^v//g' | sort -V | tail -n 1)"
 
 # support transition from an old reecetech calver style (yyyy-mm-Rr, where R is the literal `R`, and r is the nth release for the month)
 if [[ -z "${current_version:-}" ]] ; then
-    current_version="$(git tag -l | { ${grep} -P "${pcre_old_calver}" || true; } | sort -V --reverse | head -n1)"
+    current_version="$(git tag -l | { ${grep} -P "${pcre_old_calver}" || true; } | sort -V | tail -n 1)"
     if [[ -n "${current_version:-}" ]] ; then
         # convert - to . and drop leading zeros & the R
         current_version="$(echo "${current_version}" | sed -r 's/^([0-9]+)-0{0,1}([0-9]+)-R0{0,1}([0-9]+)$/\1.\2.\3/')"
@@ -63,4 +61,5 @@ fi
 
 echo "ℹ️ The current normal version is ${current_version}"
 
-echo "::set-output name=current-version::${current_version}"
+echo "CURRENT_VERSION=${current_version}" >> "${GITHUB_OUTPUT}"
+echo "CURRENT_V_VERSION=v${current_version}" >> "${GITHUB_OUTPUT}"