feat(build): enhance versioning and publishing logic in Docker action and GitHub workflow

pflooky · pflooky · commit d9a5000c46e6 · 2025-11-26T15:23:52.000+11:00
- Updated docker-action.sh to determine version based on branch and commit hash.
- Added conditional logic to publish to Maven only on the main branch.
- Modified build.yml to set version dynamically based on the branch, supporting feature and bugfix branches.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+      - 'feature/**'
+      - 'bugfix/**'
 
 jobs:
   build:
@@ -13,6 +15,21 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 2
+      - name: Set version based on branch
+        id: version
+        run: |
+          BASE_VERSION=$(grep version gradle.properties | cut -d= -f2)
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            VERSION="$BASE_VERSION"
+          else
+            VERSION="$BASE_VERSION-$COMMIT_HASH"
+          fi
+
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Building version: $VERSION"
       - uses: actions/setup-java@v4
         with:
           java-version: '17'
@@ -27,6 +44,8 @@ jobs:
       - name: Build and push images
         run: bash docker-action.sh
         env:
+          VERSION: ${{ env.VERSION }}
+          GITHUB_REF: ${{ github.ref }}
           PACKAGE_TOKEN: ${{ secrets.PACKAGE_TOKEN }}
           MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
@@ -58,7 +77,18 @@ jobs:
         with:
           fetch-depth: 2
       - name: Set version
-        run: echo "APP_VERSION=$(grep version gradle.properties | cut -d= -f2)" >> $GITHUB_ENV
+        run: |
+          BASE_VERSION=$(grep version gradle.properties | cut -d= -f2)
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            APP_VERSION="$BASE_VERSION"
+          else
+            APP_VERSION="$BASE_VERSION-$COMMIT_HASH"
+          fi
+
+          echo "APP_VERSION=$APP_VERSION" >> $GITHUB_ENV
+          echo "Building version: $APP_VERSION"
       - uses: actions/setup-java@v4
         with:
           java-version: '21'
@@ -90,7 +120,18 @@ jobs:
         with:
           fetch-depth: 2
       - name: Set version
-        run: echo "APP_VERSION=$(grep version gradle.properties | cut -d= -f2)" >> $env:GITHUB_ENV
+        run: |
+          $BASE_VERSION = (Get-Content gradle.properties | Select-String '^version=' | ForEach-Object { $_ -replace 'version=','' }).Trim()
+          $COMMIT_HASH = git rev-parse --short HEAD
+
+          if ("${{ github.ref }}" -eq "refs/heads/main") {
+            $APP_VERSION = $BASE_VERSION
+          } else {
+            $APP_VERSION = "$BASE_VERSION-$COMMIT_HASH"
+          }
+
+          echo "APP_VERSION=$APP_VERSION" >> $env:GITHUB_ENV
+          Write-Output "Building version: $APP_VERSION"
       - uses: actions/setup-java@v4
         with:
           java-version: '21'
@@ -115,23 +156,25 @@ jobs:
 
   linux-amd64:
     needs: build
-    strategy:
-      matrix:
-        include:
-          - runner: ubuntu-latest
-            arch: x64
-            arch_name: amd64
-          - runner: ubuntu-latest
-            arch: aarch64
-            arch_name: arm64
-    runs-on: ${{ matrix.runner }}
+    runs-on: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 2
       - name: Set version
-        run: echo "APP_VERSION=$(grep version gradle.properties | cut -d= -f2)" >> $GITHUB_ENV
+        run: |
+          BASE_VERSION=$(grep version gradle.properties | cut -d= -f2)
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            APP_VERSION="$BASE_VERSION"
+          else
+            APP_VERSION="$BASE_VERSION-$COMMIT_HASH"
+          fi
+
+          echo "APP_VERSION=$APP_VERSION" >> $GITHUB_ENV
+          echo "Building version: $APP_VERSION"
       - uses: actions/setup-java@v4
         with:
           java-version: '21'
@@ -173,7 +216,18 @@ jobs:
         with:
           fetch-depth: 2
       - name: Set version
-        run: echo "APP_VERSION=$(grep version gradle.properties | cut -d= -f2)" >> $GITHUB_ENV
+        run: |
+          BASE_VERSION=$(grep version gradle.properties | cut -d= -f2)
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            APP_VERSION="$BASE_VERSION"
+          else
+            APP_VERSION="$BASE_VERSION-$COMMIT_HASH"
+          fi
+
+          echo "APP_VERSION=$APP_VERSION" >> $GITHUB_ENV
+          echo "Building version: $APP_VERSION"
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
         with:
diff --git a/docker-action.sh b/docker-action.sh
@@ -1,14 +1,38 @@
 #!/usr/bin/env bash
 
-version=$(grep version gradle.properties | cut -d= -f2)
+# Determine version: use env var if set, otherwise get from gradle.properties with commit hash
+if [ -n "$VERSION" ]; then
+  version="$VERSION"
+else
+  base_version=$(grep version gradle.properties | cut -d= -f2)
+  commit_hash=$(git rev-parse --short HEAD)
+
+  # Check if on main branch
+  if [[ "$GITHUB_REF" == "refs/heads/main" ]]; then
+    version="$base_version"
+  else
+    version="$base_version-$commit_hash"
+  fi
+fi
+
 platforms="linux/amd64,linux/arm64"
 
-echo "Creating API jars and publishing, version=$version"
-./gradlew clean :api:javadocJar :api:sourcesJar :api:shadowJar publishToSonatype closeAndReleaseSonatypeStagingRepository
-publish_res=$?
-if [[ "$publish_res" -ne 0 ]] ; then
-  echo "Publish API jar failed, exiting"
-#  exit 1
+echo "Building version: $version"
+echo "Branch/Ref: ${GITHUB_REF:-local}"
+
+# Only publish to Maven on main branch
+if [[ "$GITHUB_REF" == "refs/heads/main" ]]; then
+  echo "Creating API jars and publishing to Maven, version=$version"
+  ./gradlew clean :api:javadocJar :api:sourcesJar :api:shadowJar publishToSonatype closeAndReleaseSonatypeStagingRepository
+  publish_res=$?
+  if [[ "$publish_res" -ne 0 ]] ; then
+    echo "Publish API jar failed, exiting"
+  #  exit 1
+  fi
+else
+  echo "Feature branch detected - skipping Maven publish"
+  echo "Creating API jars locally, version=$version"
+  ./gradlew clean :api:javadocJar :api:sourcesJar :api:shadowJar
 fi
 
 echo "Creating data caterer fat jars, version=$version"
@@ -23,5 +47,16 @@ docker run --privileged --rm tonistiigi/binfmt --install all
 docker buildx create --use --name builder
 docker buildx inspect --bootstrap builder
 
+# Build and tag Docker images
+echo "Building and pushing Docker image with tag: $version"
 docker buildx build --platform $platforms \
   -t datacatering/data-caterer:$version --push .
+
+# Also tag as 'latest' only for main branch
+if [[ "$GITHUB_REF" == "refs/heads/main" ]]; then
+  echo "Main branch - also tagging as 'latest'"
+  docker buildx build --platform $platforms \
+    -t datacatering/data-caterer:latest --push .
+else
+  echo "Feature branch - skipping 'latest' tag"
+fi
diff --git a/docs/use-case/changelog/0.17.3.md b/docs/use-case/changelog/0.17.3.md
@@ -16,3 +16,6 @@ Latest features and fixes for Data Caterer include fixing the connection details
 - Build for macOS x86_64, linux arm64
 - Fix the nightly links to downloads by pushing when main branch is updated instead of tag push.
 - Fix the hostname resolution for the UI when running on a different machine than the API.
+- Updated docker-action.sh to determine version based on branch and commit hash.
+- Added conditional logic to publish to Maven only on the main branch.
+- Modified build.yml to set version dynamically based on the branch, supporting feature and bugfix branches.
