firmware/.github/workflows/docker_build.yml

name: Build Docker

# Build Docker image, push untagged (digest-only)

on:
  workflow_call:
    secrets:
      DOCKER_FIRMWARE_TOKEN:
        required: false # Only required for push
    inputs:
      distro:
        description: Distro to target
        required: true
        type: string
        # choices: [debian, alpine]
      platform:
        description: Platform to target
        required: true
        type: string
      runs-on:
        description: Runner to use
        required: true
        type: string
      push:
        description: Push images to registry
        required: false
        type: boolean
        default: false
      pio_env:
        description: PlatformIO environment to build
        required: false
        type: string
        default: native
    outputs:
      digest:
        description: Digest of built image
        value: ${{ jobs.docker-build.outputs.digest }}

permissions:
  contents: read
  packages: write

jobs:
  docker-build:
    outputs:
      digest: ${{ steps.docker_variant.outputs.digest }}
    runs-on: ${{ inputs.runs-on }}
    env:
      # Only cache on default branch (develop).
      # 'docker/' actions don't support separate Restore/Save actions, so we have to disable caching entirely on PRs/merge_queue.
      USE_CACHE: ${{ github.ref_name == github.event.repository.default_branch }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v7
        with:
          submodules: recursive

      - name: Get release version string
        run: |
          echo "long=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
        id: version

      - name: Set up QEMU
        uses: docker/setup-qemu-action@v4
        with:
          cache-image: ${{ env.USE_CACHE }}

      - name: Docker setup
        uses: docker/setup-buildx-action@v4
        with:
          cache-binary: ${{ env.USE_CACHE }}
          # Add Google/Amazon DockerHub mirrors to buildkit config
          # https://docs.docker.com/build/ci/github-actions/configure-builder/#registry-mirror
          buildkitd-config-inline: |
            [registry."docker.io"]
              mirrors = ["mirror.gcr.io", "public.ecr.aws"]

      - name: Sanitize platform string
        id: sanitize_platform
        # Replace slashes with underscores
        env:
          plat: ${{ inputs.platform }}
        run: echo "cleaned_platform=${plat}" | sed 's/\//_/g' >> $GITHUB_OUTPUT

      - name: DockerHub login
        if: ${{ inputs.push }}
        uses: docker/login-action@v4
        with:
          username: meshtastic
          password: ${{ secrets.DOCKER_FIRMWARE_TOKEN }}

      - name: GHCR login
        uses: docker/login-action@v4
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Docker tag
        id: meta
        uses: docker/metadata-action@v6
        with:
          images: meshtastic/meshtasticd
          tags: |
            GHA-${{ steps.version.outputs.long }}-${{ inputs.distro }}-${{ steps.sanitize_platform.outputs.cleaned_platform }}
          flavor: latest=false

      - name: Docker setup caching
        id: docker-cache
        env:
          BASE_REF: ${{ github.event.merge_group.base_ref || github.event.pull_request.base.ref || github.ref_name }}
        run: |
          base=$(echo "${BASE_REF#refs/heads/}" | sed 's/\//_/g')
          ref=ghcr.io/${{ github.repository }}-cache:${base}-${{ inputs.distro }}-${{ steps.sanitize_platform.outputs.cleaned_platform }}
          echo "cache_from=type=registry,ref=${ref}" >> $GITHUB_OUTPUT
          case "${GITHUB_EVENT_NAME}" in
            merge_group|pull_request) ;;
            *) echo "cache_to=type=registry,ref=${ref},mode=max,ignore-error=true" >> $GITHUB_OUTPUT ;;
          esac

      - name: Docker build and push
        uses: docker/build-push-action@v7
        id: docker_variant
        with:
          context: .
          file: |
            ${{ contains(inputs.distro, 'debian') && './Dockerfile' || contains(inputs.distro, 'alpine') && './alpine.Dockerfile' }}
          push: ${{ inputs.push }}
          tags: ${{ steps.meta.outputs.tags }} # Tag is only meant to be consumed by the "manifest" job
          platforms: ${{ inputs.platform }}
          build-args: |
            PIO_ENV=${{ inputs.pio_env }}
          # Cache image layers in GitHub Container Registry to speed up subsequent builds.
          cache-from: ${{ steps.docker-cache.outputs.cache_from }}
          cache-to: ${{ steps.docker-cache.outputs.cache_to || '' }}