feat: Enable pre-release versioning (#212)

Author: jonnyandrew

.github/workflows/check-deploy-test-project.yml

@@ -31,7 +31,12 @@ jobs:
       - name: Setup runner
         uses: ./actions/common-prerequisites
 
-      - name: Increment the release version using Conventional Commits
+      - name: Increment the pre-release version using Conventional Commits
+        uses: ./actions/increment-version
+        with:
+          pre-release-type: alpha
+
+      - name: Increment the stable version using Conventional Commits
         id: versioning
         uses: ./actions/increment-version
 

actions/common-prerequisites/action.yml

@@ -16,9 +16,9 @@ runs:
         cache: gradle
 
     - name: Install Cocogitto
-      uses: cocogitto/cocogitto-action@c7a74f5406bab86da17da0f0e460a69f8219a68c # v3.11
+      uses: cocogitto/cocogitto-action@9a9fe03b31c47444290c0d7f9b1ee1b44ee13f20 # v4.1.0
       with:
-        check: false
+        command: help # A no-op command
 
     - name: Set up Homebrew
       id: set-up-homebrew

actions/increment-version/action.yml

@@ -1,28 +1,65 @@
 name: 'Increment version'
-description: 'Increment the release version using Conventional Commits'
+description: |
+  Increment the release version based on Conventional Commits.
+
+  If there are releasable changes (e.g. fix or feature commits) since the
+  previous release then this action will tag a new version.
+
+  If there are no releasable changes (e.g. only ci or docs commits) since the
+  previous release, this action does nothing.
+inputs:
+  pre-release-type:
+    type: string
+    required: false
+    description: |
+      The pre-release version type, for example "alpha".
+
+      A numeric identifier will be appended and incremented automatically.
 
 outputs:
   current_version:
-    description: 'current semantic version'
+    description: |
+      The semantic version, prior to the version increment.
+
+      If a pre-release version is supplied to the action, and the latest
+      version was a pre-release, this will be a pre-release.
     value: ${{ steps.versioning.outputs.current_version }}
   new_version:
-    description: 'new semantic version'
+    description: |
+      If this action bumped the version, this is the new version.
+
+      If this action didn't bump the version, this will be the same as the
+      current version.
+
+      If a pre-release version is supplied to the action, this may be a
+      new pre-release.
     value: ${{ steps.versioning.outputs.new_version }}
 
 runs:
   using: "composite"
   steps:
-    - name: Increment the release version using Conventional Commits
-      id: versioning
+    - name: Configure Git user
       run: |
         git config user.name github-actions
         git config user.email github-actions@github.com
+      shell: bash
 
-        current_version=$(cog -v get-version)
-        echo "current_version=$current_version" >> $GITHUB_OUTPUT
+    - name: Set Github Action path
+      run: echo "$GITHUB_ACTION_PATH" >> $GITHUB_PATH
+      shell: bash
+      env:
+        GITHUB_ACTION_PATH: ${{ github.action_path }}
 
-        cog bump --auto
+    - name: Calculate the pre-release version
+      id: pre-release
+      if: ${{ inputs.pre-release-type != '' }}
+      run: calculate_prerelease.bash "$PRE_RELEASE_TYPE" >> $GITHUB_OUTPUT
+      shell: bash
+      env:
+        PRE_RELEASE_TYPE: ${{ inputs.pre-release-type }}
 
-        new_version=$(cog -v get-version)
-        echo "new_version=$new_version" >> $GITHUB_OUTPUT
-      shell: bash
+    - name: Increment the release version using Conventional Commits
+      run: increment_version.bash "$PRE_RELEASE" >> $GITHUB_OUTPUT
+      shell: bash
+      env:
+        PRE_RELEASE: ${{ steps.pre-release.outputs.version }}

actions/increment-version/calculate_prerelease.bash

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+if [ $# -ne 1 ]; then
+  echo "Usage: calculate_prerelease.bash <PRE_RELEASE_TYPE>" >&2
+  echo "Example: calculate_prerelease.bash alpha" >&2
+  exit 1
+fi
+
+prerelease_type="$1"
+
+echo "Calculating the next pre-release version" >&2
+
+# Only increment the pre-release if there are changes to release
+next_stable_version=$(cog bump --auto --dry-run --skip-untracked)
+if [ "$next_stable_version" == "" ]; then
+  echo "There's nothing to release" >&2
+  exit 0
+fi
+echo "Next stable version would be $next_stable_version" >&2
+
+# Get the latest pre-release (if any)
+cur_prerelease_version=$(
+  cog -v get-version --tag --include-prereleases |
+    grep "$prerelease_type"
+)
+echo "Latest pre-release version: ${cur_prerelease_version:-none}" >&2
+
+# Start or increment the pre-release number
+if [[ "$cur_prerelease_version" =~ ${prerelease_type}\.([0-9]+) ]]; then
+  cur_prerelease_number=${BASH_REMATCH[1]}
+  next_prerelease_number=$((cur_prerelease_number + 1))
+  echo "Incrementing $prerelease_type: $cur_prerelease_number -> $next_prerelease_number" >&2
+else
+  echo "Starting a new $prerelease_type sequence" >&2
+  next_prerelease_number=1
+fi
+
+# Output is formatted for Github Actions step output
+# E.g. version=alpha.123
+echo "version=$prerelease_type.$next_prerelease_number"

actions/increment-version/increment_version.bash

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+pre_release=$1
+
+if [[ -n "${pre_release:-}" ]]; then
+  echo "This is a pre-release: $pre_release" >&2
+  cog_get_version_flags=(--include-prereleases)
+  cog_bump_flags=(--auto --pre "$pre_release" --skip-untracked)
+else
+  echo "This is a not a pre-release" >&2
+  cog_get_version_flags=()
+  cog_bump_flags=(--auto --skip-untracked)
+fi
+
+echo "cog_get_version_flags=${cog_get_version_flags[*]}" >&2
+echo "cog_bump_flags=${cog_bump_flags[*]}" >&2
+
+current_version=$(cog -v get-version "${cog_get_version_flags[@]}")
+cog bump "${cog_bump_flags[@]}"
+new_version=$(cog -v get-version "${cog_get_version_flags[@]}")
+
+# Output is formatted for Github Actions step output
+echo "current_version=$current_version"
+echo "new_version=$new_version"

actions/setup-runner/action.yml

@@ -42,9 +42,9 @@ runs:
       shell: bash
 
     - name: Install cocogitto
-      uses: cocogitto/cocogitto-action@c7a74f5406bab86da17da0f0e460a69f8219a68c # v3.11
+      uses: cocogitto/cocogitto-action@9a9fe03b31c47444290c0d7f9b1ee1b44ee13f20 # v4.1.0
       with:
-        check: false
+        command: help # A no-op command
 
     - name: Install KVM hardware acceleration Dependencies
       # see docs: https://help.ubuntu.com/community/KVM/Installation

actions/verify-conventional-commit/action.yml

@@ -5,9 +5,9 @@ runs:
   using: "composite"
   steps:
     - name: Install Cocogitto
-      uses: cocogitto/cocogitto-action@c7a74f5406bab86da17da0f0e460a69f8219a68c # v3.11
+      uses: cocogitto/cocogitto-action@9a9fe03b31c47444290c0d7f9b1ee1b44ee13f20 # v4.1.0
       with:
-        check: false
+        command: help # A no-op command
 
     - name: Verify Conventional commit standards against latest git tag
       run: cog check -l