Avoid version 2020 warning

e.g.

```
🛑 The major version number is greater than 2020, but the scheme is not set to 'calver'
```

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

@@ -9,56 +9,12 @@ on:
       - '**'
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Run ShellCheck
-        uses: ludeeus/action-shellcheck@94e0aab03ca135d11a35e5bfc14e6746dc56e7e9
-        with:
-          check_together: 'yes'
-
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
+      - name: Get next version
-        uses: actions/checkout@v2
+        uses: reecetech/version-increment@use_api
-
+        id: version
-      - name: Setup bats
-        uses: mig4/setup-bats@af9a00deb21b5d795cabfeaa8d9060410377686d
         with:
-          bats-version: 1.4.1
-
-      - name: Test
-        run: bats tests/*.bats
-
-  release:
-    needs:
-      - lint
-      - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - 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
-
+          use_api: true
-      - name: Release version
-        uses: marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0
-        if: ${{ github.ref == 'refs/heads/main' }}
-        with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          draft: false
-          prerelease: false
-          automatic_release_tag: "${{ steps.version-increment.outputs.version }}"

README.md

@@ -9,7 +9,7 @@
         uses: actions/checkout@v2
 
       - name: Get next version
-        uses: reecetech/version-increment@2022.2.3
+        uses: reecetech/version-increment@2023.9.3
         id: version
         with:
           scheme: semver
@@ -24,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
@@ -52,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`
@@ -67,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`
@@ -75,10 +81,12 @@ Examples:
 
 ### 📥 Inputs
 
-| name      | description                                               | required | default  |
+| name           | description                                                                                 | required | default  |
-| :---      | :---                                                      | :---     | :---     |
+| :---           | :---                                                                                        | :---     | :---     |
-| scheme    | The versioning scheme in-use, either `semver` or `calver` | No       | `semver` |
+| scheme         | The versioning scheme in-use, either `semver` or `calver`                                   | No       | `semver` |
-| 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
 
@@ -88,6 +96,13 @@ Examples:
 | 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

@@ -11,6 +11,10 @@ inputs:
     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)
@@ -18,20 +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:
     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 }}
+    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 }}  
+    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"
@@ -46,6 +75,8 @@ runs:
       run: ${{ github.action_path }}/version-increment.sh
       shell: bash
       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

@@ -21,6 +21,12 @@ if [[ "${scheme}" != 'semver' && "${scheme}" != 'calver' ]] ; then
     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
 
@@ -32,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

@@ -53,6 +53,18 @@ function init_repo {
     [[ "$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
 
@@ -65,6 +77,13 @@ function init_repo {
     [[ "$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
 
@@ -75,7 +94,10 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.2.4"* ]]
+    [[ "$output" = *"MAJOR_VERSION=1"* ]] &&
+    [[ "$output" = *"MINOR_VERSION=2"* ]] &&
+    [[ "$output" = *"PATCH_VERSION=4"* ]] &&
+    [[ "$output" = *"VERSION=1.2.4"* ]]
 }
 
 @test "increments the minor digit correctly (semver)" {
@@ -88,7 +110,27 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.3.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)" {
@@ -101,7 +143,27 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::2.0.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" {
@@ -114,8 +176,11 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::2.0.0"* ]] &&
+    [[ "$output" = *"VERSION=2.0.0"* ]] &&
-    [[ "$output" = *"::set-output name=v-version::v2.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)" {
@@ -128,7 +193,7 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::$(date +%Y.%-m.1)"* ]]
+    [[ "$output" = *"VERSION=$(date +%Y.%-m.1)"* ]]
 }
 
 @test "increments the patch digit within a month (calver)" {
@@ -141,7 +206,7 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::$(date +%Y.%-m.124)"* ]]
+    [[ "$output" = *"VERSION=$(date +%Y.%-m.124)"* ]]
 }
 
 @test "appends prerelease information if on a branch" {
@@ -155,5 +220,55 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=version::1.2.4-pre.${short_ref}"* ]]
+    [[ "$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

@@ -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,7 @@ 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" {
@@ -52,8 +59,8 @@ function init_repo {
 
     print_run_info
     [ "$status" -eq 0 ] &&
-    [[ "$output" = *"::set-output name=current-version::0.1.2"* ]] &&
+    [[ "$output" = *"CURRENT_VERSION=0.1.2"* ]] &&
-    [[ "$output" = *"::set-output name=current-v-version::v0.1.2"* ]]
+    [[ "$output" = *"CURRENT_V_VERSION=v0.1.2"* ]]
 }
 
 @test "finds the current normal version even if there's a newer pre-release version" {
@@ -66,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" {
@@ -76,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" {
@@ -88,7 +95,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 a calver if no normal version detected and calver scheme specified" {
@@ -100,7 +107,7 @@ function init_repo {
 
     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" {
@@ -112,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" {
@@ -124,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"* ]]
 }

version-increment.sh

@@ -32,6 +32,11 @@ default_branch='main'
 if [[ -z "${BATS_VERSION:-}" ]] ; then
     default_branch="$(git remote show origin | ${grep} 'HEAD branch' | cut -d ' ' -f 5)"
 fi
+# use release_branch if not empty
+if [[ -n "${release_branch:-}" ]] ; then
+    default_branch="${release_branch}" 
+fi
+
 current_ref="${GITHUB_REF:-}"
 git_commit="$(git rev-parse --short HEAD | sed 's/0*//')"  # trim leading zeros, because semver doesn't allow that in
                                                            # the 'pre-release version' part, but we can't use the + char
@@ -74,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
@@ -86,5 +97,12 @@ fi
 
 echo "ℹ️ The new version is ${new_version}"
 
-echo "::set-output name=version::${new_version}"
+# shellcheck disable=SC2129
-echo "::set-output name=v-version::v${new_version}"
+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

@@ -27,7 +27,7 @@ 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
 
 ##==----------------------------------------------------------------------------
@@ -61,5 +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 "::set-output name=current-v-version::v${current_version}"
+echo "CURRENT_V_VERSION=v${current_version}" >> "${GITHUB_OUTPUT}"