esp-matter/.github/workflows/docker-image.yml

# Copyright 2022 Espressif Systems (Shanghai) PTE LTD
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Build Docker

on:
  push:
    branches:
      - 'main'
      - 'release/*'
    tags:
      - 'v*.*'

  # Can be run manually
  workflow_dispatch:

env:
  DOCKERHUB_REPO: ${{ github.repository }}
  REQUIRED_IDF_VERSION: v5.4.1

jobs:
  build:
    # Disable the job in forks
    if: ${{ github.repository_owner == 'espressif' }}

    strategy:
      fail-fast: true
      matrix:
        # Platforms to build the image for
        # Using native runners for each architecture to avoid slow QEMU emulation
        include:
          - platform: linux/amd64
            runner: ubuntu-24.04
          - platform: linux/arm64
            runner: ubuntu-24.04-arm
    runs-on: ${{ matrix.runner }}

    steps:
      # Workaround for disk space issues on the GitHub runner
      - run: sudo rm -rf /usr/share/dotnet
      - run: sudo rm -rf "$AGENT_TOOLSDIRECTORY"

      # The following steps are the standard boilerplate from
      # https://docs.docker.com/build/ci/github-actions/multi-platform/
      - name: Checkout
        uses: actions/checkout@v4

      - name: Prepare artifact name
        run: |
          platform=${{ matrix.platform }}
          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV

      - name: Docker meta
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ env.DOCKERHUB_REPO }}

      - name: Set up QEMU
        uses: docker/setup-qemu-action@v3

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

      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.DOCKER_PASSWORD }}

      - name: Build and push by digest
        id: build
        uses: docker/build-push-action@v6
        with:
          context: tools/docker/matter_builds
          labels: ${{ steps.meta.outputs.labels }}
          platforms: ${{ matrix.platform }}
          outputs: type=image,name=${{ env.DOCKERHUB_REPO }},push-by-digest=true,name-canonical=true,push=true
          build-args: |
            ESP_MATTER_CLONE_URL=${{ github.server_url }}/${{ github.repository }}.git
            ESP_MATTER_CHECKOUT_REF=${{ github.ref_name }}
            IDF_CHECKOUT_REF=${{ env.REQUIRED_IDF_VERSION }}

      - name: Export digest
        run: |
          mkdir -p /tmp/digests
          digest="${{ steps.build.outputs.digest }}"
          touch "/tmp/digests/${digest#sha256:}"

      - name: Upload digest
        uses: actions/upload-artifact@v4
        with:
          name: digests-${{ env.PLATFORM_PAIR }}
          path: /tmp/digests/*
          if-no-files-found: error
          retention-days: 1

  merge:
    runs-on: ubuntu-latest
    needs:
      - build
    steps:
      # Depending on the branch/tag, set TAG_NAME (used when tagging the image).
      #
      # The following 3 steps cover the alternatives (tag, release branch, main branch):
      - name: Set variables (tags)
        if: ${{ github.ref_type == 'tag' }}
        run: |
          echo "TAG_NAME=$GITHUB_REF_NAME" >> $GITHUB_ENV
      - name: Set variables (release branches)
        if: ${{ github.ref_type == 'branch' && startsWith(github.ref_name, 'release/') }}
        run: |
          echo "TAG_NAME=release-${GITHUB_REF_NAME##release/}" >> $GITHUB_ENV
      - name: Set variables (main branch)
        if: ${{ github.ref_type == 'branch' && github.ref_name == 'main' }}
        run: |
          echo "TAG_NAME=latest" >> $GITHUB_ENV

      - name: Download digests
        uses: actions/download-artifact@v4
        with:
          path: /tmp/digests
          pattern: digests-*
          merge-multiple: true

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

      - name: Docker meta
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ env.DOCKERHUB_REPO }}
          tags: |
            ${{ env.TAG_NAME }}
            ${{ env.TAG_NAME }}_idf_${{ env.REQUIRED_IDF_VERSION }}

      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.DOCKER_PASSWORD }}

      - name: Create manifest list and push
        working-directory: /tmp/digests
        run: |
          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
            $(printf '${{ env.DOCKERHUB_REPO }}@sha256:%s ' *) 

      - name: Inspect image
        run: |
          docker buildx imagetools inspect ${{ env.DOCKERHUB_REPO }}:${{ steps.meta.outputs.version }}