feat(docker): update workflow to push images on branch pushes and refine tag handling

Author: angelorc

.github/workflows/push-docker-image.yml

@@ -1,47 +1,44 @@
-# This workflow pushes new Bitsong docker images on every new tag.
+# This workflow pushes new Bitsong docker images on every new tag or branch push.
 #
 # On every new `vX.Y.Z` tag the following images are pushed:
 #
 # bitsongofficial/go-bitsong:vX.Y.Z   # is pushed
 # bitsongofficial/go-bitsong:X.Y.Z    # is pushed
 # bitsongofficial/go-bitsong:X.Y      # is updated to X.Y.Z
 # bitsongofficial/go-bitsong:X        # is updated to X.Y.Z
-# bitsongofficial/go-bitsong:latest   # is updated to X.Y.Z
 #
-# bitsongofficial/go-bitsong-e2e:vX.Y.Z   # is pushed
-# bitsongofficial/go-bitsong-e2e:X.Y.Z    # is pushed
-# bitsongofficial/go-bitsong-e2e:X.Y      # is updated to X.Y.Z
-# bitsongofficial/go-bitsong-e2e:X        # is updated to X.Y.Z
-# bitsongofficial/go-bitsong-e2e:latest   # is updated to X.Y.Z
+# On branch pushes (e.g. feat-hyperlane) the following images are pushed:
+#
+# bitsongofficial/go-bitsong:feat-hyperlane          # latest for that branch
+# bitsongofficial/go-bitsong:feat-hyperlane-abc1234  # pinned to commit
 #
 # All the images above have support for linux/amd64 and linux/arm64.
 
 name: Push Docker Images
 
 env:
   DOCKER_REPOSITORY: bitsongofficial/go-bitsong
-  RUNNER_BASE_IMAGE_DISTROLESS: gcr.io/distroless/static-debian12
-  RUNNER_BASE_IMAGE_NONROOT: gcr.io/distroless/static-debian12:nonroot
-  RUNNER_BASE_IMAGE_ALPINE: alpine:3.21
 
 on:
   release:
     types: [published, created, edited]
   push:
     tags:
-    - 'v[0-9]+.[0-9]+.[0-9]+' # ignore rc
+      - 'v[0-9]+.[0-9]+.[0-9]+'  # ignore rc
+    branches:
+      - 'feat-hyperlane'
 
 jobs:
   bitsong-images:
     runs-on: ubuntu-latest
     steps:
-      - 
+      -
         name: Check out the repo
         uses: actions/checkout@v4
-      - 
+      -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-      - 
+      -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to GitHub Container Registry
@@ -51,28 +48,38 @@ jobs:
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
-        name: Parse tag
-        id: tag
+        name: Determine image tags
+        id: tags
         run: |
-          VERSION=$(echo ${{ github.ref_name }} | sed "s/v//")
-          MAJOR_VERSION=$(echo $VERSION | cut -d '.' -f 1)
-          MINOR_VERSION=$(echo $VERSION | cut -d '.' -f 2)
-          PATCH_VERSION=$(echo $VERSION | cut -d '.' -f 3)
-          echo "VERSION=$VERSION" >> $GITHUB_ENV
-          echo "MAJOR_VERSION=$MAJOR_VERSION" >> $GITHUB_ENV
-          echo "MINOR_VERSION=$MINOR_VERSION" >> $GITHUB_ENV
-          echo "PATCH_VERSION=$PATCH_VERSION" >> $GITHUB_ENV
-      - 
-        name: Build and push 
+          SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
+
+          if [[ "${{ github.ref_type }}" == "tag" ]]; then
+            # Tag push: produce semver tags (e.g. v0.21.0 -> 0, 0.21, 0.21.0, v0.21.0)
+            VERSION=$(echo "${{ github.ref_name }}" | sed "s/v//")
+            MAJOR_VERSION=$(echo "$VERSION" | cut -d '.' -f 1)
+            MINOR_VERSION=$(echo "$VERSION" | cut -d '.' -f 2)
+            PATCH_VERSION=$(echo "$VERSION" | cut -d '.' -f 3)
+            IMAGE_TAGS="ghcr.io/${{ env.DOCKER_REPOSITORY }}:${MAJOR_VERSION}
+          ghcr.io/${{ env.DOCKER_REPOSITORY }}:${MAJOR_VERSION}.${MINOR_VERSION}
+          ghcr.io/${{ env.DOCKER_REPOSITORY }}:${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}
+          ghcr.io/${{ env.DOCKER_REPOSITORY }}:v${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}"
+          else
+            # Branch push: produce branch + commit-pinned tags
+            BRANCH=$(echo "${{ github.ref_name }}" | sed 's/\//-/g')
+            IMAGE_TAGS="ghcr.io/${{ env.DOCKER_REPOSITORY }}:${BRANCH}
+          ghcr.io/${{ env.DOCKER_REPOSITORY }}:${BRANCH}-${SHORT_SHA}"
+          fi
+
+          echo "IMAGE_TAGS<<EOF" >> $GITHUB_OUTPUT
+          echo "$IMAGE_TAGS" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+      -
+        name: Build and push
         id: build_push_image
         uses: docker/build-push-action@v5
         with:
           file: Dockerfile
           context: .
           push: true
           platforms: linux/amd64,linux/arm64
-          tags: |
-            ghcr.io/bitsongofficial/go-bitsong:${{ env.MAJOR_VERSION }}
-            ghcr.io/bitsongofficial/go-bitsong:${{ env.MAJOR_VERSION }}.${{ env.MINOR_VERSION }}
-            ghcr.io/bitsongofficial/go-bitsong:${{ env.MAJOR_VERSION }}.${{ env.MINOR_VERSION }}.${{ env.PATCH_VERSION }}
-            ghcr.io/bitsongofficial/go-bitsong:v${{ env.MAJOR_VERSION }}.${{ env.MINOR_VERSION }}.${{ env.PATCH_VERSION }}
+          tags: ${{ steps.tags.outputs.IMAGE_TAGS }}