🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
ci: refactor Docker publish workflow for clearer job structure and conditional push
Andrii Andrushchyshynb250b5e09458
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.ymlindex 4c031c091..9418c4e04 100644--- a/.github/workflows/docker-publish.yml+++ b/.github/workflows/docker-publish.yml@@ -3,49 +3,41 @@ name: Docker Publishon:push:branches:- - master # Trigger workflow on push to master branch+ - mastertags:- - "v*" # Trigger workflow on version tag push (e.g., v1.2.3)+ - 'v*'pull_request:branches:- - master # Trigger workflow on pull requests to master branch+ - masterjobs:- client:+ build-client:name: Build Client Images-permissions:- contents: read # Allows reading repository contents- packages: write # Required to push images to GitHub Container Registry (GHCR)-+ contents: read+ packages: write+ runs-on: ${{ matrix.os }}strategy:- fail-fast: false # Continue building other platforms even if one fails+ fail-fast: falsematrix:include:- - os: ubuntu-latest- arch: amd64- platform: linux/amd64 # x86_64 architecture- - os: ubuntu-24.04-arm- arch: arm64- platform: linux/arm64 # ARM architecture-- runs-on: ${{ matrix.os }} # Use the selected OS from the matrix+ -+ os: ubuntu-latest+ platform: linux/amd64+ -+ os: ubuntu-24.04-arm+ platform: linux/arm64steps:- - name: Checkout repository- uses: actions/checkout@v4 # Checkout the code from the repository-+ - uses: actions/checkout@v4+ - uses: docker/setup-buildx-action@v3- name: Log in to GitHub Container Registryuses: docker/login-action@v3with:- registry: ghcr.io # GitHub Container Registry URL- username: ${{ github.repository_owner }} # GitHub repository owner- password: ${{ secrets.GITHUB_TOKEN }} # Token to authenticate with GHCR-- - name: Set up Docker Buildx- uses: docker/setup-buildx-action@v3 # Set up Docker Buildx for building multi-platform images-- - name: Prepare Environment Variables for Build+ registry: ghcr.io+ username: ${{ github.repository_owner }}+ password: ${{ secrets.GITHUB_TOKEN }}+ - name: Set env varsrun: |# Define platform pair (e.g., linux-amd64) and save to environment variablesplatform=${{ matrix.platform }}@@ -54,79 +46,63 @@ jobs:# Define repository owner in lowercase for GHCR and save to envecho "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV- # Set short git commit SHA and branch name, then save to env+ # Set short git commit SHA then save to envcalculatedSha=$(git rev-parse --short HEAD)- branchName=$(git rev-parse --abbrev-ref HEAD)echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV- echo "COMMIT_BRANCH=$branchName" >> $GITHUB_ENV-- - name: Extract metadata (tags, labels) for Docker+ - name: Extract metadataid: metauses: docker/metadata-action@v5with:images: ghcr.io/${{ env.REPO_OWNER }}/rybbit-client-- - name: Build and push client by digest+ - name: Build (no push on purpose)id: builduses: docker/build-push-action@v6with:- context: ./client # Path to the Dockerfile for the client- file: ./client/Dockerfile # Dockerfile for the client- platforms: ${{ matrix.platform }} # Build the image for the platform specified in the matrix+ context: ./client+ file: ./client/Dockerfile+ platforms: ${{ matrix.platform }}labels: ${{ steps.meta.outputs.labels }}- # Push image by digest only; manifest list will be created later- outputs: type=image,"name=ghcr.io/${{ env.REPO_OWNER }}/rybbit-client",push-by-digest=true,name-canonical=true,push=true-+ outputs: type=image,"name=ghcr.io/${{ env.REPO_OWNER }}/rybbit-client",push-by-digest=true,name-canonical=true+ push: "${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}"- name: Export digestsrun: |# Create a temporary directory to store digestsmkdir -p /tmp/digests# Save the digests of client imagesecho "${{ steps.build.outputs.digest }}" > /tmp/digests/client-${{ env.PLATFORM_PAIR }}-- - name: Upload digest- uses: actions/upload-artifact@v4+ - uses: actions/upload-artifact@v4with:- name: digests-client-${{ env.PLATFORM_PAIR }} # Name of the artifact (unique per platform)- path: /tmp/digests/* # Path to the digests files- if-no-files-found: error # Fail if no files are found- retention-days: 1 # Retain artifacts for 1 day+ name: digests-client-${{ env.PLATFORM_PAIR }}+ path: '/tmp/digests/*'+ retention-days: 1- backend:+ build-backend:name: Build Backend Images-permissions:- contents: read # Allows reading repository contents- packages: write # Required to push images to GitHub Container Registry (GHCR)-+ contents: read+ packages: write+ runs-on: ${{ matrix.os }}strategy:- fail-fast: false # Continue building other platforms even if one fails+ fail-fast: falsematrix:include:- - os: ubuntu-latest- arch: amd64- platform: linux/amd64 # x86_64 architecture- - os: ubuntu-24.04-arm- arch: arm64- platform: linux/arm64 # ARM architecture-- runs-on: ${{ matrix.os }} # Use the selected OS from the matrix+ -+ os: ubuntu-latest+ platform: linux/amd64+ -+ os: ubuntu-24.04-arm+ platform: linux/arm64steps:- - name: Checkout repository- uses: actions/checkout@v4 # Checkout the code from the repository-+ - uses: actions/checkout@v4+ - uses: docker/setup-buildx-action@v3- name: Log in to GitHub Container Registryuses: docker/login-action@v3with:- registry: ghcr.io # GitHub Container Registry URL- username: ${{ github.repository_owner }} # GitHub repository owner- password: ${{ secrets.GITHUB_TOKEN }} # Token to authenticate with GHCR-- - name: Set up Docker Buildx- uses: docker/setup-buildx-action@v3 # Set up Docker Buildx for building multi-platform images-- - name: Prepare Environment Variables for Build+ registry: ghcr.io+ username: ${{ github.repository_owner }}+ password: ${{ secrets.GITHUB_TOKEN }}+ - name: Set env varsrun: |# Define platform pair (e.g., linux-amd64) and save to environment variablesplatform=${{ matrix.platform }}@@ -135,82 +111,67 @@ jobs:# Define repository owner in lowercase for GHCR and save to envecho "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV- # Set short git commit SHA and branch name, then save to env+ # Set short git commit SHA then save to envcalculatedSha=$(git rev-parse --short HEAD)- branchName=$(git rev-parse --abbrev-ref HEAD)echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV- echo "COMMIT_BRANCH=$branchName" >> $GITHUB_ENV-- - name: Extract metadata (tags, labels) for Docker+ - name: Extract metadataid: metauses: docker/metadata-action@v5with:images: ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend-- - name: Build and push backend by digest+ - name: Build (no push on purpose)id: builduses: docker/build-push-action@v6with:- context: ./server # Path to the Dockerfile for the backend- file: ./server/Dockerfile # Dockerfile for the backend- platforms: ${{ matrix.platform }} # Build the image for the platform specified in the matrix+ context: ./server+ file: ./server/Dockerfile+ platforms: ${{ matrix.platform }}labels: ${{ steps.meta.outputs.labels }}- # Push image by digest only; manifest list will be created later- outputs: type=image,"name=ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend",push-by-digest=true,name-canonical=true,push=true-+ outputs: type=image,"name=ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend",push-by-digest=true,name-canonical=true+ push: "${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}"- name: Export digestsrun: |# Create a temporary directory to store digestsmkdir -p /tmp/digests# Save the digests of backend imagesecho "${{ steps.build.outputs.digest }}" > /tmp/digests/backend-${{ env.PLATFORM_PAIR }}-- - name: Upload digest- uses: actions/upload-artifact@v4+ - uses: actions/upload-artifact@v4with:- name: digests-backend-${{ env.PLATFORM_PAIR }} # Name of the artifact (unique per platform)- path: /tmp/digests/* # Path to the digests files- if-no-files-found: error # Fail if no files are found- retention-days: 1 # Retain artifacts for 1 day-- merge:- name: Merge Images and Push-- runs-on: ubuntu-latest-- needs:- - backend # Wait for client before running the merge job- - client # Wait for client before running the merge job+ name: digests-backend-${{ env.PLATFORM_PAIR }}+ path: '/tmp/digests/*'+ retention-days: 1+ publish-images:+ name: Merge & Push Multi-arch Manifestspermissions:- contents: read # Allows reading repository contents- packages: write # Required to push images to GitHub Container Registry (GHCR)+ contents: read+ packages: write+ needs:+ - build-client+ - build-backend+ if: "${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}"+ runs-on: ubuntu-lateststeps:- name: Download digestsuses: actions/download-artifact@v4with:- path: /tmp/digests # Download the digests to the /tmp/digests directory- pattern: digests-* # Match all artifacts starting with 'digests-'- merge-multiple: true # Merge all platform digests into one folder-- - name: Prepare Environment Variables for Merge+ path: /tmp/digests+ pattern: 'digests-*'+ merge-multiple: true+ - name: Set env varsrun: |# Define repository owner in lowercase for GHCR and save to envecho "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV-- name: Log in to GitHub Container Registryuses: docker/login-action@v3with:- registry: ghcr.io # GitHub Container Registry URL- username: ${{ github.repository_owner }} # GitHub repository owner- password: ${{ secrets.GITHUB_TOKEN }} # Token to authenticate with GHCR-- - name: Set up Docker Buildx- uses: docker/setup-buildx-action@v3 # Set up Docker Buildx for multi-platform builds-- - name: Extract client metadata (tags, labels)- id: client-meta+ registry: ghcr.io+ username: ${{ github.repository_owner }}+ password: ${{ secrets.GITHUB_TOKEN }}+ - uses: docker/setup-buildx-action@v3+ - name: Metadata client+ id: meta-clientuses: docker/metadata-action@v5with:images: ghcr.io/${{ env.REPO_OWNER }}/rybbit-client@@ -229,9 +190,10 @@ jobs:# Always add short SHA tag for traceabilitytype=sha,priority=700-- - name: Create manifest list and push client images- working-directory: /tmp/digests # Change working directory to /tmp/digests+ - name: Push manifest client+ working-directory: /tmp/digests+ env:+ TAGS_JSON: ${{ steps.meta-client.outputs.json }}run: |digests=""@@ -243,11 +205,10 @@ jobs:# Create a manifest list and push to GHCRdocker buildx imagetools create \- $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \+ $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$TAGS_JSON") \$digests-- - name: Extract backend metadata (tags, labels)- id: backend-meta+ - name: Metadata backend+ id: meta-backenduses: docker/metadata-action@v5with:images: ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend@@ -266,9 +227,10 @@ jobs:# Always add short SHA tag for traceabilitytype=sha,priority=700-- - name: Create manifest list and push backend images- working-directory: /tmp/digests # Change working directory to /tmp/digests+ - name: Push manifest backend+ working-directory: /tmp/digests+ env:+ TAGS_JSON: ${{ steps.meta-backend.outputs.json }}run: |digests=""@@ -280,17 +242,15 @@ jobs:# Create a manifest list and push to GHCRdocker buildx imagetools create \- $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \+ $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$TAGS_JSON") \$digests-- name: Inspect client imagesrun: |# Inspect the client image to verify the pushecho "Inspecting client..."- docker buildx imagetools inspect ghcr.io/${{ env.REPO_OWNER }}/rybbit-client:${{ steps.client-meta.outputs.version }}-+ docker buildx imagetools inspect ghcr.io/${{ env.REPO_OWNER }}/rybbit-client:${{ steps.meta-client.outputs.version }}- name: Inspect backend images- run: |+ run: |-# Inspect the backend image to verify the pushecho "Inspecting backend..."- docker buildx imagetools inspect ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend:${{ steps.backend-meta.outputs.version }}+ docker buildx imagetools inspect ghcr.io/${{ env.REPO_OWNER }}/rybbit-backend:${{ steps.meta-backend.outputs.version }}