Merge pull request #41 from reecetech/fixup

Fix: wrong version variable

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

@@ -27,9 +27,9 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup bats
-        uses: mig4/setup-bats@af9a00deb21b5d795cabfeaa8d9060410377686d  # v1.2.0
+        uses: bats-core/bats-action@2.0.0
         with:
-          bats-version: 1.8.0
+          bats-version: 1.11.0
 
       - name: Test
         run: bats tests/*.bats
@@ -72,12 +72,20 @@ jobs:
       - lint
       - test
       - test-api-mode
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout code  # have to checkout to have the source code available
         uses: actions/checkout@v4
 
       - name: Remove .git directory  # remove the git directory to make the testing valid
+        shell: bash
         run: rm -rf .git/
 
       - name: Get next version via API
@@ -106,6 +114,23 @@ jobs:
           [[ "${{ steps.version-via-api.outputs.patch-version }}" == "${{ steps.version-via-git.outputs.patch-version }}" ]]
           # Don't test the full version or pre-version, since the number of digits is likely to be different (9 via api vs. 7 via git)
 
+      - name: Get next version via Git with tag-prefix
+        uses: ./
+        id: version-prefix
+        with:
+          scheme: 'semver'
+          use_api: false
+          tag_prefix: 'foo/bar@'
+
+      - name: Check that it starts from 0.0.1 (since prefix doesn't exist)
+        shell: bash
+        run: |
+          [[ "${{ steps.version-prefix.outputs.current-version }}" == "0.0.0" ]]
+          [[ "${{ steps.version-prefix.outputs.major-version }}" == "0" ]]
+          [[ "${{ steps.version-prefix.outputs.minor-version }}" == "0" ]]
+          [[ "${{ steps.version-prefix.outputs.patch-version }}" == "1" ]]
+          [[ "${{ steps.version-prefix.outputs.prefixed-version }}" = "foo/bar@0.0.1"* ]]
+
   release:
     needs:
       - test-action-yml
@@ -114,21 +139,16 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Lookup version
-        id: version-lookup
-        run: ./version-lookup.sh
-
-      - name: Increment version
-        id: version-increment
-        run: ./version-increment.sh
-        env:
-          current_version: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
-          scheme: calver
+      - name: Get next version
+        uses: ./
+        id: version
+        with:
+          scheme: 'calver'
 
       - name: Release version
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: ${{ github.ref_name == github.event.repository.default_branch }}
         with:
           draft: false
           prerelease: false
-          tag_name: "${{ steps.version-increment.outputs.VERSION }}"
+          tag_name: "${{ steps.version.outputs.version }}"

README.md

@@ -2,6 +2,10 @@
 
 ## Use 📄
 
+> [!NOTE]
+> This action is confirmed to work on all three of GitHub's hosted runners - 
+> `ubuntu-latest`, `macos-latest` and `windows-latest` - at the point in time of the release of the action
+
 ### Example ⌨️
 
 ```yaml
@@ -9,7 +13,7 @@
         uses: actions/checkout@v4
 
       - name: Get next version
-        uses: reecetech/version-increment@2023.9.3
+        uses: reecetech/version-increment@2024.10.1
         id: version
         with:
           scheme: semver
@@ -30,7 +34,7 @@ use the API mode:
 
 ```yaml
       - name: Get next version
-        uses: reecetech/version-increment@2024.4.1
+        uses: reecetech/version-increment@2024.10.1
         id: version
         with:
           use_api: true
@@ -128,6 +132,7 @@ 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 📤
 
@@ -144,6 +149,8 @@ Examples:
 | 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 💕
 

action.yml

@@ -40,6 +40,11 @@ inputs:
     description: 'Use the GitHub API to discover current tags, which avoids the need for a git checkout, but requires `curl` and `jq`'
     required: false
     default: false
+  tag_prefix:
+    description: |
+      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: ''
 
 outputs:
   current-version:
@@ -75,20 +80,27 @@ outputs:
   patch-v-version:
     description: 'Patch number of the incremented version, prefixed with a `v` charatcter'
     value: ${{ steps.version-increment.outputs.PATCH_V_VERSION }}
+  prefixed-version:
+    description: 'Incremented version calculated, including a `tag_prefix` if specified'
+    value: ${{ inputs.tag_prefix}}${{ steps.version-increment.outputs.VERSION }}
+  prefixed-v-version:
+    description: 'Incremented version calculated, prefixed with a `v` charatcter, and also including a `tag_prefix` if specified'
+    value: ${{ inputs.tag_prefix}}${{ steps.version-increment.outputs.V_VERSION }}
 
 runs:
   using: "composite"
   steps:
     - id: version-lookup
-      run: ${{ github.action_path }}/version-lookup.sh
+      run: "${GITHUB_ACTION_PATH}/version-lookup.sh"
       shell: bash
       env:
         github_token: ${{ github.token }}
         scheme: ${{ inputs.scheme }}
         use_api: ${{ inputs.use_api }}
+        tag_prefix: ${{ inputs.tag_prefix }}
 
     - id: version-increment
-      run: ${{ github.action_path }}/version-increment.sh
+      run: "${GITHUB_ACTION_PATH}/version-increment.sh"
       shell: bash
       env:
         current_version: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}

shared.sh

@@ -2,6 +2,9 @@
 # shellcheck disable=SC2034
 set -euo pipefail
 
+# Force UTF-8 for all commands, for Git-Bash on Windows compatibility
+export LC_ALL=C.UTF-8
+
 ##==----------------------------------------------------------------------------
 ##  SemVer regexes
 ##  see: https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
@@ -11,6 +14,28 @@ pcre_master_ver='^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9
 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*)$'
 
+##==----------------------------------------------------------------------------
+##  Utility function for removing tag_prefix if present
+
+remove_prefix() {
+    local tag="$1"
+    if [[ -n "${tag_prefix:-}" ]]; then
+        # Escape special characters in tag_prefix
+        local escaped_prefix
+        escaped_prefix=$(printf '%s\n' "$tag_prefix" | sed 's/[][\/.^$*]/\\&/g')  # special chars matched by sed: ] [ / . ^ $ *
+
+	# shellcheck disable=SC2143
+        if [[ -z "$(echo "${tag}" | grep "^${tag_prefix}")" ]] ; then
+            echo ""
+            return
+        fi
+	# shellcheck disable=SC2001
+        echo "${tag}" | sed "s|^${escaped_prefix}||"  # Use | as the delimiter to avoid conflicts with /
+    else
+        echo "${tag}"
+    fi
+}
+
 ##==----------------------------------------------------------------------------
 ## Conventional commit regexes
 ## see: https://www.conventionalcommits.org/en/v1.0.0/
@@ -48,18 +73,39 @@ if [[ "${use_api}" == 'true' ]] ; then
     fi
 fi
 
-##==----------------------------------------------------------------------------
-##  MacOS compatibility - for local testing
+# Check if the tag_prefix is set, and if not, set it to an empty string
+tag_prefix="${tag_prefix:-}"
 
-export grep="grep"
-if [[ "$(uname)" == "Darwin" ]] ; then
-    export grep="ggrep"
-    if ! grep --version 1>/dev/null ; then
+##==----------------------------------------------------------------------------
+##  MacOS compatibility
+
+export use_perl="false"
+export use_gnugrep="false"
+if [[ "${GITHUB_ACTIONS:-}" == 'true' && "$(uname)" == 'Darwin' ]] ; then
+    export use_perl="true"
+elif [[ "$(uname)" == 'Darwin' ]] ; then
+    if perl --version 1>/dev/null ; then
+        export use_perl="true"
+    elif ! ggrep --version 1>/dev/null ; then
         echo "🛑 GNU grep not installed, try brew install coreutils" 1>&2
         exit 9
+    else
+        export use_gnugrep="true"
     fi
 fi
 
+function grep_p() {
+    if [[ "${use_perl}" == 'true' ]] ; then
+        perl -ne "print if /${1}/"
+    elif [[ "${use_gnugrep}" == 'true' ]] ; then
+        # shellcheck disable=SC2086
+        ggrep -P "${1}"
+    else
+        # shellcheck disable=SC2086
+        command grep -P "${1}"
+    fi
+}
+
 ##==----------------------------------------------------------------------------
 ##  Non GitHub compatibility - for testing both locally and in BATS
 

tests/test_version-increment.bats

@@ -1,6 +1,15 @@
 #!/usr/bin/env bats
 # vim: set ft=sh sw=4 :
 
+setup() {
+    # get the containing directory of this file
+    # use $BATS_TEST_FILENAME instead of ${BASH_SOURCE[0]} or $0,
+    # as those will point to the bats executable's location or the preprocessed file respectively
+    DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )"
+    # make executables in src/ visible to PATH
+    PATH="$DIR/../:$PATH"
+}
+
 load helper_print-info
 
 export repo=".tmp_testing/repo"
@@ -22,7 +31,7 @@ function init_repo {
 @test "fails if no current_version given" {
     init_repo
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -34,7 +43,7 @@ function init_repo {
 
     export current_version=1.3.5-prerelease
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -46,7 +55,7 @@ function init_repo {
 
     export scheme="foover"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -58,7 +67,7 @@ function init_repo {
 
     export pep440="yes"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -70,7 +79,7 @@ function init_repo {
 
     export increment="critical"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -90,7 +99,7 @@ function init_repo {
     export current_version=1.2.3
     export increment="patch"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -106,7 +115,7 @@ function init_repo {
     export current_version=1.2.3
     export increment="minor"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -123,7 +132,7 @@ function init_repo {
     export pep404="false"
     export increment="minor"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -139,7 +148,7 @@ function init_repo {
     export current_version=1.2.3
     export increment="major"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -156,7 +165,7 @@ function init_repo {
     export pep404="true"
     export increment="major"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -172,7 +181,7 @@ function init_repo {
     export current_version=1.2.3
     export increment="major"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -189,7 +198,7 @@ function init_repo {
     export current_version=2020.6.4
     export scheme="calver"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -202,7 +211,7 @@ function init_repo {
     export current_version="$(date +%Y.%-m.123)"
     export scheme="calver"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -216,7 +225,7 @@ function init_repo {
     export GITHUB_REF="refs/heads/super-awesome-feature"
     export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -231,7 +240,7 @@ function init_repo {
     export GITHUB_REF="refs/heads/releases"
     export release_branch="releases"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -248,7 +257,7 @@ function init_repo {
     export GITHUB_REF="refs/heads/super-awesome-python"
     export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -265,7 +274,7 @@ function init_repo {
     export GITHUB_REF="refs/heads/super-awesome-python"
     export short_ref="$(git rev-parse --short HEAD | sed 's/0*//')"
 
-    run ../../version-increment.sh
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -400,3 +409,24 @@ function init_repo {
     [[ "$output" = *"VERSION=1.2.4"* ]]
     [[ "$output" = *"No conventional commit found"* ]]
 }
+
+
+@test "increments the patch version by default if no conventional commits found and enabled (conventional commits) (with tag_prefix)" {
+    init_repo
+
+    export tag_prefix="@org/product@"
+    export current_version="1.2.3"
+    export scheme="conventional_commits"
+
+    echo "some new change" > feat.txt
+    git add feat.txt
+    git commit -m "new change"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=1.2.4"* ]]
+    [[ "$output" = *"V_VERSION=v1.2.4"* ]]
+    [[ "$output" = *"No conventional commit found"* ]]
+}

tests/test_version-lookup.bats

@@ -5,6 +5,15 @@ load helper_print-info
 
 export repo=".tmp_testing/repo"
 
+setup() {
+    # get the containing directory of this file
+    # use $BATS_TEST_FILENAME instead of ${BASH_SOURCE[0]} or $0,
+    # as those will point to the bats executable's location or the preprocessed file respectively
+    DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )"
+    # make executables in src/ visible to PATH
+    PATH="$DIR/../:$PATH"
+}
+
 function init_repo {
     rm -rf "${repo}" &&
     mkdir -p "${repo}" &&
@@ -22,7 +31,7 @@ function init_repo {
 
     export scheme="foover"
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -43,7 +52,7 @@ function init_repo {
     git tag 0.1.1
     git tag 0.1.2
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -55,7 +64,38 @@ function init_repo {
 
     git tag 0.1.2
 
-    run ../../version-lookup.sh
+    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 with tag_prefix enabled" {
+    init_repo
+
+    export tag_prefix="@org/product@"
+
+    git tag @org/product@0.0.1
+    git tag @org/product@0.1.1
+    git tag @org/product@0.1.2
+
+    run version-lookup.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"CURRENT_VERSION=0.1.2"* ]]
+}
+
+@test "tag_prefix enabled prefixes with a v" {
+    init_repo
+
+    export tag_prefix="@org/product/"
+
+    git tag @org/product/0.1.2
+
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -69,17 +109,35 @@ function init_repo {
     git tag 1.2.300
     git tag 1.2.301-dev.234
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
     [[ "$output" = *"CURRENT_VERSION=1.2.300"* ]]
 }
 
+@test "finds only prefixed tags when tag_prefix set" {
+    init_repo
+
+    export tag_prefix="my_product-"
+
+    git tag my_product-0.1.2
+    git tag my_product-0.1.3-dev.123
+    git tag 2.4.5
+    git tag 2.4.6-dev.456
+
+    run version-lookup.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"CURRENT_VERSION=0.1.2"* ]] &&
+    [[ "$output" = *"CURRENT_V_VERSION=v0.1.2"* ]]
+}
+
 @test "returns 0.0.0 if no normal version detected" {
     init_repo
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -91,7 +149,21 @@ function init_repo {
 
     git tag 0.0.1-dev.999
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"CURRENT_VERSION=0.0.0"* ]]
+}
+
+@test "returns 0.0.0 if no prefix version detected even if there's a non-prefix release version" {
+    init_repo
+
+    export tag_prefix="code/"
+
+    git tag 0.1.0
+
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -103,7 +175,7 @@ function init_repo {
 
     export scheme="calver"
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
@@ -115,7 +187,7 @@ function init_repo {
 
     git tag v3.4.5
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&

version-increment.sh

@@ -15,7 +15,7 @@ fi
 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
+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
@@ -43,7 +43,7 @@ elif [[ -z "${BATS_VERSION:-}" ]] ; then
             | jq -r '.default_branch'
         )"
     else
-        default_branch="$(git remote show origin | ${grep} 'HEAD branch' | cut -d ' ' -f 5)"
+        default_branch="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f 5)"
     fi
 fi
 
@@ -67,13 +67,13 @@ if [[ "${scheme}" == 'conventional_commits' ]] ; then
 
     # Check commit message header
     found_match='false'
-    if [[ -n "$(echo "${commit_message}" | ${grep} -P "${pcre_conventional_commit_breaking}")" ]] ; then
+    if [[ -n "$(echo "${commit_message}" | grep_p "${pcre_conventional_commit_breaking}")" ]] ; then
         increment='major'
         found_match='true'
-    elif [[ -n "$(echo "${commit_message}" | ${grep} -P "${pcre_conventional_commit_minor}")" ]] ; then
+    elif [[ -n "$(echo "${commit_message}" | grep_p "${pcre_conventional_commit_minor}")" ]] ; then
         increment='minor'
         found_match='true'
-    elif [[ -n "$(echo "${commit_message}" | ${grep} -P "${pcre_conventional_commit_patch}")" ]] ; then
+    elif [[ -n "$(echo "${commit_message}" | grep_p "${pcre_conventional_commit_patch}")" ]] ; then
         increment='patch'
         found_match='true'
     fi
@@ -128,7 +128,7 @@ if [[ "${current_ref}" != "refs/heads/${default_branch}" ]] ; then
     echo "PRE_RELEASE_LABEL=${pre_release}" >> "${GITHUB_OUTPUT}"
 fi
 
-if [[ -z "$(echo "${new_version}" | ${grep} -P "${pcre_semver}")" ]] ; then
+if [[ -z "$(echo "${new_version}" | grep_p "${pcre_semver}")" ]] ; then
     echo "🛑 Version incrementing has failed to produce a semver compliant version" 1>&2
     echo "ℹ️ See: https://semver.org/spec/v2.0.0.html" 1>&2
     echo "ℹ️ Failed version string: '${new_version}'" 1>&2

version-lookup.sh

@@ -32,12 +32,18 @@ if [[ "${use_api:-}" == 'true' ]] ; then
             -H "X-GitHub-Api-Version: 2022-11-28" \
             "${GITHUB_API_URL}/repos/${GITHUB_REPOSITORY}/git/matching-refs/tags/" \
         | jq -r '.[].ref' | sed 's|refs/tags/||g' \
-        | { ${grep} -P "${pcre_allow_vprefix}" || true; } | sed 's/^v//g' | sort -V | tail -n 1
+        | while read -r tag; do remove_prefix "$tag"; done \
+        | { grep_p "${pcre_allow_vprefix}" || true; } \
+        | sed 's/^v//g' \
+        | sort -V | tail -n 1
     )"
 else
     current_version="$(
         git tag -l \
-        | { ${grep} -P "${pcre_allow_vprefix}" || true; } | sed 's/^v//g' | sort -V | tail -n 1
+        | while read -r tag; do remove_prefix "$tag"; done \
+        | { grep_p "${pcre_allow_vprefix}" || true; } \
+        | sed 's/^v//g' \
+        | sort -V | tail -n 1
     )"
 fi