Merge pull request #41 from reecetech/fixup

Fix: wrong version variable

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

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run ShellCheck
-        uses: ludeeus/action-shellcheck@94e0aab03ca135d11a35e5bfc14e6746dc56e7e9  # v1.1.0
+        uses: ludeeus/action-shellcheck@2.0.0
         with:
           check_together: 'yes'
 
@@ -24,41 +24,131 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        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
 
-  release:
-    needs:
-      - lint
-      - test
+  test-api-mode:  # requires github API, didn't want to mock it
     runs-on: ubuntu-latest
+    env:
+      github_token: ${{ github.token }}
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
+      - name: Checkout code  # have to checkout to have the source code available
+        uses: actions/checkout@v4
 
-      - name: Lookup version
+      - name: Remove .git directory  # remove the git directory to make the testing valid
+        run: rm -rf .git/
+
+      - name: Test lookup version (with API)
         id: version-lookup
+        env:
+          use_api: 'true'
         run: ./version-lookup.sh
 
-      - name: Increment version
+      - name: Check lookup result
+        shell: bash
+        run: '[[ -n "${{ steps.version-lookup.outputs.CURRENT_VERSION }}" ]]'
+
+      - name: Test increment version (with API)
         id: version-increment
         run: ./version-increment.sh
         env:
           current_version: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
           scheme: calver
+          use_api: 'true'
+
+      - name: Check increment result
+        shell: bash
+        run: '[[ "$(date +%Y.%-m)" == "$(echo "${{ steps.version-increment.outputs.VERSION }}" | cut -d "." -f 1-2)" ]]'
+
+  test-action-yml:  # integration testing
+    needs:
+      - lint
+      - test
+      - test-api-mode
+    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
+        uses: ./
+        id: version-via-api
+        with:
+          scheme: 'calver'
+          use_api: true
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get next version via Git
+        uses: ./
+        id: version-via-git
+        with:
+          scheme: 'calver'
+          use_api: false
+
+      - name: Check results agree
+        shell: bash
+        run: |
+          [[ "${{ steps.version-via-api.outputs.current-version }}" == "${{ steps.version-via-git.outputs.current-version }}" ]]
+          [[ "${{ steps.version-via-api.outputs.major-version }}" == "${{ steps.version-via-git.outputs.major-version }}" ]]
+          [[ "${{ steps.version-via-api.outputs.minor-version }}" == "${{ steps.version-via-git.outputs.minor-version }}" ]]
+          [[ "${{ 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
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get next version
+        uses: ./
+        id: version
+        with:
+          scheme: 'calver'
 
       - name: Release version
-        uses: marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0  # v1.2.1
+        uses: softprops/action-gh-release@v2
         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.outputs.version }}"

.shellcheckrc

@@ -0,0 +1 @@
+external-sources=true

README.md

@@ -1,15 +1,19 @@
-# ➕ Version Increment
+# Version Increment ➕
 
-## 📄 Use
+## Use 📄
 
-### ⌨️ Example
+> [!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
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Get next version
-        uses: reecetech/version-increment@2023.3.1
+        uses: reecetech/version-increment@2024.10.1
         id: version
         with:
           scheme: semver
@@ -23,7 +27,21 @@
           context: .
 ```
 
-### 🔖 semver
+#### API mode 🔗
+
+Maybe you don't want to checkout your code in the job that calculates the version number.  That's okay, you can
+use the API mode:
+
+```yaml
+      - name: Get next version
+        uses: reecetech/version-increment@2024.10.1
+        id: version
+        with:
+          use_api: true
+```
+
+### 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
@@ -36,7 +54,7 @@ e.g. `1.2.7`
 
 See: https://semver.org/spec/v2.0.0.html
 
-### 📅 calver (semver compliant)
+### calver (semver compliant) 📅
 
 Optionally, this action can provide semver compliant calendar versions (calver).
 In this calver scheme, the semver  major, minor and patch digits map to year,
@@ -52,35 +70,71 @@ 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
+### Conventional Commits (semver with smarts) 💡
+
+If you choose the conventional commits scheme, the action will parse the last commit message _(usually the merge commit)_ to determine
+the increment type for a `semver` version.
+
+The following increment types by keyword are supported:
+ - patch: build, chore, ci, docs, fix, perf, refactor, revert, style, test
+ - minor: feat
+ - major: any of the above keywords followed by a '!' character, or 'BREAKING CHANGE:' in commit body
+
+If none of the keywords are detected, then the increment specified by the `increment` input will be used (defaults to patch).
+
+> [!TIP]
+> You might like to _enforce_ conventional commits in the title of your pull requests to ensure that the merge commit has the correct
+> information.  Something like this action might be handy: https://github.com/marketplace/actions/conventional-commit-in-pull-requests
+
+### 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`
 * `2021.6.2`
 
+You may override the branch to consider the release branch if it is not the default branch, by providing a specific
+release branch name as an input.  For example:
+
+```yaml
+      - name: Get next version
+        uses: reecetech/version-increment@2023.10.1
+        id: version
+        with:
+          release_branch: publish
+```
+
 **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`
 * `2021.6.2-pre.32fd19841`
 
-### 📥 Inputs
+### Inputs 📥
 
 | name           | description                                                                                 | required | default  |
 | :---           | :---                                                                                        | :---     | :---     |
-| scheme    | The versioning scheme in-use, either `semver` or `calver` | No       | `semver` |
+| scheme         | The versioning scheme in-use, either `semver`, `calver` or `conventional_commits`           | 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`  |
 | 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
+### Outputs 📤
 
 | name               | description                                                                                                    |
 | :---               | :---                                                                                                           |
@@ -95,8 +149,10 @@ 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
+## Contributing 💕
 
 Please raise a pull request, but note the testing tools below
 

action.yml

@@ -8,23 +8,50 @@ branding:
 
 inputs:
   scheme:
-    description: 'Versioning scheme - semver, or, calver (defaults to semver)'
+    description: |
+      Versioning scheme - semver, calver or conventional_commits (defaults to semver).
+
+      `conventional_commits` Will parse the last commit message (e.g. the merge commit) to
+      determine the increment type, and supports the following increment types by keyword:
+      - patch (build, chore, ci, docs, fix, perf, refactor, revert, style, test)
+      - minor (feat)
+      - major (any of the above keywords followed by a '!' character, or 'BREAKING CHANGE:' in commit body)
     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)
 
+      If using the `conventional_commits` scheme, this is the default increment if the parsing of the merge commit fails to
+      find conventional commits information
+
       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
+  use_api:
+    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:
     description: 'Current normal version detected'
     value: ${{ steps.version-lookup.outputs.CURRENT_VERSION }}
   current-v-version:
-    description: 'Current normal version detected, prefixed with a `v` charatcter'
+    description: 'Current normal version detected, prefixed with a `v` character'
     value: ${{ steps.version-lookup.outputs.CURRENT_V_VERSION }}
   version:
     description: 'Incremented version calculated'
@@ -53,20 +80,33 @@ 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 }}
         increment: ${{ inputs.increment }}
+        github_token: ${{ github.token }}
+        pep440: ${{ inputs.pep440 }}
         scheme: ${{ inputs.scheme }}
+        release_branch: ${{ inputs.release_branch }}
+        use_api: ${{ inputs.use_api }}

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,28 +14,98 @@ 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/
+
+pcre_conventional_commit_patch='^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\([a-zA-Z0-9-]+\))?:\s.*'
+pcre_conventional_commit_minor='^(feat)(\([a-zA-Z0-9-]+\))?:\s.*'
+pcre_conventional_commit_breaking='^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-zA-Z0-9-]+\))?!:.*|BREAKING CHANGE:'
+
 ##==----------------------------------------------------------------------------
 ##  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
+if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' && "${scheme}" != 'conventional_commits' ]] ; then
+    echo "🛑 Value of 'scheme' is not valid, choose from 'semver', 'calver' or 'conventional_commits" 1>&2
     input_errors='true'
 fi
 
-##==----------------------------------------------------------------------------
-##  MacOS compatibility - for local testing
+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
 
-export grep="grep"
-if [[ "$(uname)" == "Darwin" ]] ; then
-    export grep="ggrep"
-    if ! grep --version 1>/dev/null ; then
-        echo "🛑 GNU grep not installed, try brew install coreutils" 1>&2
-        exit 9
+use_api="${use_api:-false}"
+if [[ "${use_api}" != 'false' && "${use_api}" != 'true' ]] ; then
+    echo "🛑 Value of 'use_api' is not valid, choose from 'false' or 'true'" 1>&2
+    input_errors='true'
+fi
+
+if [[ "${use_api}" == 'true' ]] ; then
+    if [[ -z "${github_token:-}" ]] ; then
+        echo "🛑 'use_api' is true, but environment variable 'github_token' is not set" 1>&2
+        input_errors='true'
     fi
 fi
 
+# Check if the tag_prefix is set, and if not, set it to an empty string
+tag_prefix="${tag_prefix:-}"
+
+##==----------------------------------------------------------------------------
+##  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,19 +55,31 @@ function init_repo {
 
     export scheme="foover"
 
-    run ../../version-increment.sh
+    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
+    run version-increment.sh
 
     print_run_info
     [ "$status" -eq 8 ] &&
@@ -78,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 ] &&
@@ -94,7 +115,24 @@ 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 ] &&
+    [[ "$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 ] &&
@@ -110,7 +148,24 @@ 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 ] &&
+    [[ "$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 ] &&
@@ -126,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 ] &&
@@ -143,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 ] &&
@@ -156,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 ] &&
@@ -170,10 +225,208 @@ 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
+
+    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}"* ]]
+}
+
+@test "increments the patch version after a fix commit (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "fix: something" > fix.txt
+    git add fix.txt
+    git commit -m "fix: something"
+
     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}"* ]]
+    [[ "$output" = *"VERSION=1.2.4"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+
+@test "increments the patch version after a scoped fix commit (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "fix: something" > fix.txt
+    git add fix.txt
+    git commit -m "fix(api): something"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=1.2.4"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+@test "increments the major version after a breaking fix commit (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "fix: breaking something" > fix.txt
+    git add fix.txt
+    git commit -m "fix!: something"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=2.0.0"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+@test "increments the minor version after a feat commit (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "new feature" > feat.txt
+    git add feat.txt
+    git commit -m "feat: something"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=1.3.0"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+@test "increments the major version after a breaking feat commit (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "breaking new feature" > feat.txt
+    git add feat.txt
+    git commit -m "feat!: something"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=2.0.0"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+@test "increments the major version after a breaking change in the commit body (conventional commits)" {
+    init_repo
+
+    export current_version=1.2.3
+    export scheme="conventional_commits"
+
+    echo "breaking new fix" > feat.txt
+    git add feat.txt
+    git commit -m "Fix: something
+    BREAKING CHANGE: really important"
+
+    run ../../version-increment.sh
+
+    print_run_info
+    [ "$status" -eq 0 ] &&
+    [[ "$output" = *"VERSION=2.0.0"* ]]
+    [[ "$output" != *"No conventional commit found"* ]]
+}
+
+@test "increments the patch version by default if no conventional commits found and enabled (conventional commits)" {
+    init_repo
+
+    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" = *"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,31 +175,19 @@ function init_repo {
 
     export scheme="calver"
 
-    run ../../version-lookup.sh
+    run version-lookup.sh
 
     print_run_info
     [ "$status" -eq 0 ] &&
     [[ "$output" = *"CURRENT_VERSION=$(date '+%Y.%-m.0')"* ]]
 }
 
-@test "converts from older calver scheme automatically" {
-    init_repo
-
-    git tag 2020-09-R2
-
-    run ../../version-lookup.sh
-
-    print_run_info
-    [ "$status" -eq 0 ] &&
-    [[ "$output" = *"CURRENT_VERSION=2020.9.2"* ]]
-}
-
 @test "strips v from the version" {
     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
@@ -28,15 +28,60 @@ fi
 ##  Git info - branch names, commit short ref
 
 default_branch='main'
-# if we're _not_ testing, then _actually_ check the origin
-if [[ -z "${BATS_VERSION:-}" ]] ; then
-    default_branch="$(git remote show origin | ${grep} 'HEAD branch' | cut -d ' ' -f 5)"
+# use release_branch if not empty
+if [[ -n "${release_branch:-}" ]] ; then
+    default_branch="${release_branch}"
+elif [[ -z "${BATS_VERSION:-}" ]] ; then
+    # if we're _not_ testing, then _actually_ check the origin
+    if [[ "${use_api:-}" == 'true' ]] ; then
+        default_branch="$(
+            curl -fsSL \
+                -H "Accept: application/vnd.github+json" \
+                -H "Authorization: Bearer ${github_token}" \
+                -H "X-GitHub-Api-Version: 2022-11-28" \
+                "${GITHUB_API_URL}/repos/${GITHUB_REPOSITORY}" \
+            | jq -r '.default_branch'
+        )"
+    else
+        default_branch="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f 5)"
+    fi
 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
-                                                           # to make it 'build metadata' as that's not supported in K8s
-                                                           # labels
+git_commit_sha=${GITHUB_SHA:-}
+
+if [[ "${use_api:-}" == 'true' ]] ; then
+    # because we cannot use `rev-parse` with the API, we'll take a punt that 9 characters is enough for uniqueness
+    # shellcheck disable=SC2001
+    git_commit="$(echo "${GITHUB_SHA:0:9}" | sed 's/0*//')"    # Also, trim leading zeros, because semver doesn't allow that in
+else                                                           # the 'pre-release version' part, but we can't use the + char
+    git_commit="$(git rev-parse --short HEAD | sed 's/0*//')"  # to make it 'build metadata' as that's not supported in K8s
+    git_commit_sha="$(git rev-parse --short HEAD)"             # labels
+fi
+
+##==----------------------------------------------------------------------------
+##  Conventional commits
+if [[ "${scheme}" == 'conventional_commits' ]] ; then
+    # Get message from given commit
+    commit_message=$(git log -1 --pretty=format:%B "${git_commit_sha}")
+
+    # Check commit message header
+    found_match='false'
+    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
+        increment='minor'
+        found_match='true'
+    elif [[ -n "$(echo "${commit_message}" | grep_p "${pcre_conventional_commit_patch}")" ]] ; then
+        increment='patch'
+        found_match='true'
+    fi
+
+    if [[ "${found_match}" == 'false' ]] ; then
+        echo "⚠️ No conventional commit found, defaulting to ${increment} increment" 1>&2
+    fi
+fi
 
 ##==----------------------------------------------------------------------------
 ##  Version increment
@@ -75,11 +120,15 @@ fi
 # add pre-release info to version if not the default branch
 if [[ "${current_ref}" != "refs/heads/${default_branch}" ]] ; then
     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
+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

@@ -10,39 +10,41 @@ if [[ "${input_errors}" == 'true' ]] ; then
     exit 8
 fi
 
-##==----------------------------------------------------------------------------
-##  MacOS compatibility - for local testing
-
-export grep="grep"
-if [[ "$(uname)" == "Darwin" ]] ; then
-    export grep="ggrep"
-    if ! grep --version 1>/dev/null ; then
-        echo "🛑 GNU grep not installed, try brew install coreutils" 1>&2
-        exit 9
-    fi
-fi
-
 ##==----------------------------------------------------------------------------
 ##  Get tags from GitHub repo
 
-# Skip if testing, otherwise pull tags
+# Skip if testing, or if use_api is true, otherwise pull tags
 if [[ -z "${BATS_VERSION:-}" ]] ; then
+    if [[ "${use_api:-}" != 'true' ]] ; then
         git fetch --quiet --force origin 'refs/tags/*:refs/tags/*'
+    fi
 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 | 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 | 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/')"
-    fi
+if [[ "${use_api:-}" == 'true' ]] ; then
+    current_version="$(
+        curl -fsSL \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${github_token}" \
+            -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' \
+        | 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 \
+        | 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
 
 # handle no version detected - start versioning!
@@ -50,7 +52,7 @@ if [[ -z "${current_version:-}" ]] ; then
     echo "⚠️ No previous release version identified in git tags"
     # brand new repo! (probably)
     case "${scheme}" in
-        semver)
+        semver | conventional_commits)
             current_version="0.0.0"
         ;;
         calver)