workflow-build-push-container-github-registry.yml

---
name: Reusable workflow to build and push docker container to github container registry

on:
  workflow_call:
    inputs:
      container-name:
        required: true
        type: string
      tag:
        required: true
        type: string
      registry:
        required: true
        type: string
      dockerfile-folder-path:
        required: false
        type: string

jobs:
  build-push-image:
    runs-on: ubuntu-latest
    steps:
      - name: Check Out Repo
        uses: actions/checkout@v4

      - name: Set up Docker Buildx
        id: buildx
        uses: docker/setup-buildx-action@v3

      - name: Log in to the github container registry (GCR)
        uses: docker/login-action@7ca345011ac4304463197fac0e56eab1bc7e6af0
        with:
          registry: ${{ inputs.registry }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Cache Docker layers
        uses: actions/cache@v4
        with:
          path: /tmp/.buildx-cache
          key: ${{ runner.os }}-buildx-${{ github.sha }}
          restore-keys: ${{ runner.os }}-buildx

      - name: Extract branch name + remove undesired characters
        shell: bash
        id: extract_branch_name
        run: |
          BRANCH_NAME="${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}"
          CLEAN_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[\/\\]/-/g')
          echo "clean_branch_name=$CLEAN_BRANCH_NAME" >> $GITHUB_ENV
          echo "::set-output name=clean_branch_name::$CLEAN_BRANCH_NAME"

      - name: Build and push (3 tags | commit number, pr number and branch name) (unmerged)
        id: docker_build_and_tag_unmerged
        if: github.event.pull_request.merged == false
        uses: docker/build-push-action@v6
        with:
          context: ${{ inputs.dockerfile-folder-path || '.' }}
          push: true
          platforms: linux/amd64,linux/arm64
          tags: |
            ${{ inputs.registry }}/${{ inputs.container-name }}:${{ github.event.number || github.run_number }}
            ${{ inputs.registry }}/${{ inputs.container-name }}:${{ inputs.tag }}
            ${{ inputs.registry }}/${{ inputs.container-name }}:${{ steps.extract_branch_name.outputs.clean_branch_name || 'latest' }}
          cache-from: type=local,src=/tmp/.buildx-cache
          cache-to: type=local,mode=max,dest=/tmp/.buildx-cache-new

      - name: Build and push (2 tags | commit number and branch name) (merged)
        id: docker_build_and_tag_merged
        if: github.event.pull_request.merged == true
        uses: docker/build-push-action@v6
        with:
          context: ${{ inputs.dockerfile-folder-path || '.' }}
          push: true
          platforms: linux/amd64,linux/arm64
          tags: |
            ${{ inputs.registry }}/${{ inputs.container-name }}:${{ inputs.tag }}
            ${{ inputs.registry }}/${{ inputs.container-name }}:${{ github.event.pull_request.base.ref }}
          cache-from: type=local,src=/tmp/.buildx-cache
          cache-to: type=local,mode=max,dest=/tmp/.buildx-cache-new

      - name: Refresh Cache
        run: |
          rm -rf /tmp/.buildx-cache
          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

      - name: Image digest (latest)
        if: github.event.pull_request.merged == false
        run: echo ${{ steps.docker_build_and_tag_unmerged.outputs.digest }}

      - name: Image digest (latest)
        if: github.event.pull_request.merged == true
        run: echo ${{ steps.docker_build_and_tag_merged.outputs.digest }}

  remove-old-image:
    runs-on: ubuntu-latest
    needs: build-push-image
    steps:
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install the remove-previous-image from github.com/ai-cfia/devops inside the user-site
        run: >
          python -m pip install --user \
          git+https://$USER:$USER_TOKEN@github.com/ai-cfia/devops.git@main
        env:
          USER: ${{ secrets.USER }}
          USER_TOKEN: ${{ secrets.USER_TOKEN }}

      - name: Access user site-packages
        run: |
          USER_SITE=$(python -m site --user-site)
          echo "Path to site-packages is $USER_SITE"
          echo "USER_SITE=$USER_SITE" >> $GITHUB_ENV

      - name: Delete the previous image (unmerged pull request)
        if: github.event.pull_request.merged == false
        run: python $USER_SITE/remove-previous-image/remove_previous_image.py
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REGISTRY: ${{ inputs.registry }}
          CONTAINER_NAME: ${{ inputs.container-name }}
          UNIQUE_TAG: ${{ github.event.number }}
          USER: ${{ github.actor }}
          CURRENT_COMMIT: ${{ inputs.tag }}

      - name: Delete the previous image (merged pull request)
        if: github.event.pull_request.merged == true
        run: python $USER_SITE/remove-previous-image/remove_previous_image.py
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REGISTRY: ${{ inputs.registry }}
          CONTAINER_NAME: ${{ inputs.container-name }}
          UNIQUE_TAG: ${{ github.event.pull_request.base.ref }}
          USER: ${{ github.actor }}
          CURRENT_COMMIT: ${{ inputs.tag }}