build-and-push.yml

---
name: Build, test and push a Docker image

on:
  push:
    branches:
      - main
      - build-test-image
    tags:
      - v20[0-9][0-9].[01][0-9].[0-3][0-9]  # e.g. v2023.12.04
      - v20[0-9][0-9].[01][0-9].[0-3][0-9]-[0-9]  # e.g. v2023.12.04-2
  pull_request:
    branches:
      - main
  merge_group:

jobs:
  build:
    permissions:
      contents: read
      deployments: write
      id-token: write
    runs-on: ubuntu-24.04
    env:
      # Disable docker compose volume mounts in docker-compose.override.yml
      COMPOSE_FILE: docker-compose.yml
    steps:
      - uses: actions/checkout@v4
      - name: Get info
        run: |
          uname -v
          docker info
      - name: Create version.json
        run: |
          # create a version.json per
          # https://github.com/mozilla-services/Dockerflow/blob/master/docs/version_object.md
          printf '{"commit":"%s","version":"%s","source":"%s","build":"%s"}\n' \
          "$GITHUB_SHA" \
          "$GITHUB_REF_NAME" \
          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > version.json
      - name: Output version.json
        run: cat version.json
      - name: Install just
        run: sudo apt-get update && sudo apt-get install -y just
      - name: Build Docker images
        run: |
          just build
          docker compose images
      - name: Verify requirements.txt contains correct dependencies
        run: |
          just verify-reqs
      - name: Run lint check
        run: |
          just lint
      - name: Run tests
        run: |
          just test
      - name: Build docs
        run: |
          just docs

      - name: Set Docker image tag to "latest" for updates of the main branch
        if: github.ref == 'refs/heads/main'
        run: |
          echo IMAGE_TAG=latest >> "$GITHUB_ENV"
          # Updates to the main branch are deployed to stage.
          echo DEPLOYMENT_ENV=stage >> "$GITHUB_ENV"
      - name: Set Docker image tag to "test" for updates of the build-test-image branch
        if: github.ref == 'refs/heads/build-test-image'
        run: |
          # Pushing to the "build-test-image" branch builds an image tagged "test" that's not
          # deployed to any environment.
          echo IMAGE_TAG=test >> "$GITHUB_ENV"
      - name: Set Docker image tag to the git tag for tagged builds
        if: startsWith(github.ref, 'refs/tags/')
        run: |
          echo IMAGE_TAG="$GITHUB_REF_NAME" >> "$GITHUB_ENV"
          # Version tags are deployed to prod.
          echo DEPLOYMENT_ENV=prod >> "$GITHUB_ENV"
      - name: Push the Docker image to GAR
        if: env.IMAGE_TAG != ''
        uses: mozilla-it/deploy-actions/docker-push@v3.13.0
        with:
          local_image: tecken:build
          image_repo_path: ${{ secrets.DOCKER_IMAGE_PATH }}
          image_tag: ${{ env.IMAGE_TAG }}
          workload_identity_pool_project_number: ${{ secrets.WORKLOAD_IDENTITY_POOL_PROJECT_NUMBER }}
          project_id: ${{ secrets.GCP_PROJECT_ID }}
          deployment_env: ${{ env.DEPLOYMENT_ENV }}