CI: Sanitize Docker tag names.

Author: brycelelbach

.github/workflows/build-brev-tutorial-docker-images.yml

@@ -49,9 +49,12 @@ jobs:
       - name: Set Git branch variables
         run: |
           GIT_BRANCH_NAME=${GITHUB_REF#refs/heads/}
+          # Sanitize branch name for Docker tags (replace invalid characters with hyphens and convert to lowercase)
+          DOCKER_TAG_BRANCH=$(echo "${GIT_BRANCH_NAME}" | sed 's/[^a-zA-Z0-9._-]/-/g' | tr '[:upper:]' '[:lower:]')
           GIT_SHA=${{ github.sha }}
           GIT_SHORT_SHA=${GIT_SHA::7}
           echo "GIT_BRANCH_NAME=${GIT_BRANCH_NAME}" >> $GITHUB_ENV
+          echo "DOCKER_TAG_BRANCH=${DOCKER_TAG_BRANCH}" >> $GITHUB_ENV
           echo "GIT_SHA=${GIT_SHA}" >> $GITHUB_ENV
           echo "GIT_SHORT_SHA=${GIT_SHORT_SHA}" >> $GITHUB_ENV
 
@@ -113,8 +116,8 @@ jobs:
               --allow=fs.read=/home/runner \
               --set "base.args.GIT_BRANCH_NAME=${GIT_BRANCH_NAME}" \
               --set "base.output=type=registry" \
-              --set "base.tags=${IMAGE_NAME}:${GIT_BRANCH_NAME}-latest" \
-              --set "base.tags=${IMAGE_NAME}:${GIT_BRANCH_NAME}-git-${GIT_SHORT_SHA}" \
+              --set "base.tags=${IMAGE_NAME}:${DOCKER_TAG_BRANCH}-latest" \
+              --set "base.tags=${IMAGE_NAME}:${DOCKER_TAG_BRANCH}-git-${GIT_SHORT_SHA}" \
               $([ "${GIT_BRANCH_NAME}" = "main" ] && echo "--set base.tags=${IMAGE_NAME}:latest") \
               --set "base.cache-from=type=registry,ref=${IMAGE_NAME}:buildcache" \
               --set "base.cache-to=type=registry,ref=${IMAGE_NAME}:buildcache,mode=max" \
@@ -125,21 +128,21 @@ jobs:
       - name: Generate Docker Compose files
         run: |
           python3 brev/generate-tagged-docker-composes.py \
-            --image-tag "${GIT_BRANCH_NAME}-git-${GIT_SHORT_SHA}" \
+            --image-tag "${DOCKER_TAG_BRANCH}-git-${GIT_SHORT_SHA}" \
             --output-dir "artifacts/commit-specific" \
             --tutorial "${TUTORIAL_NAME}" \
             --type all
 
           python3 brev/generate-tagged-docker-composes.py \
-            --image-tag "${GIT_BRANCH_NAME}-latest" \
+            --image-tag "${DOCKER_TAG_BRANCH}-latest" \
             --output-dir "artifacts/branch-latest" \
             --tutorial "${TUTORIAL_NAME}" \
             --type all
 
       - name: Upload commit-specific Docker Compose artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: docker-compose-${{ env.TUTORIAL_NAME }}-${{ env.GIT_BRANCH_NAME }}-git-${{ env.GIT_SHORT_SHA }}
+          name: docker-compose-${{ env.TUTORIAL_NAME }}-${{ env.DOCKER_TAG_BRANCH }}-git-${{ env.GIT_SHORT_SHA }}
           path: artifacts/commit-specific/${{ env.TUTORIAL_NAME }}/
           retention-days: 30
 

.github/workflows/test-brev-tutorial-docker-images.yml

@@ -39,9 +39,12 @@ jobs:
       - name: Set Git branch variables
         run: |
           GIT_BRANCH_NAME=${GITHUB_REF#refs/heads/}
+          # Sanitize branch name for Docker tags (replace invalid characters with hyphens and convert to lowercase)
+          DOCKER_TAG_BRANCH=$(echo "${GIT_BRANCH_NAME}" | sed 's/[^a-zA-Z0-9._-]/-/g' | tr '[:upper:]' '[:lower:]')
           GIT_SHA=${{ inputs.git_sha }}
           GIT_SHORT_SHA=${GIT_SHA:0:7}
           echo "GIT_BRANCH_NAME=${GIT_BRANCH_NAME}" >> $GITHUB_ENV
+          echo "DOCKER_TAG_BRANCH=${DOCKER_TAG_BRANCH}" >> $GITHUB_ENV
           echo "GIT_SHA=${GIT_SHA}" >> $GITHUB_ENV
           echo "GIT_SHORT_SHA=${GIT_SHORT_SHA}" >> $GITHUB_ENV
 
@@ -50,7 +53,7 @@ jobs:
         with:
           workflow: build-brev-tutorial-docker-images.yml
           run_id: ${{ inputs.workflow_run_id }}
-          name: docker-compose-${{ inputs.tutorial }}-${{ env.GIT_BRANCH_NAME }}-git-${{ env.GIT_SHORT_SHA }}
+          name: docker-compose-${{ inputs.tutorial }}-${{ env.DOCKER_TAG_BRANCH }}-git-${{ env.GIT_SHORT_SHA }}
           path: artifacts/commit-specific/${{ inputs.tutorial }}/
 
       - name: Log in to GitHub Container Registry