build.yml

name: "Build container image"

on:
  push:
    branches:
      - main
    tags:
      - "*"
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}

env:
  IMAGE_NAME: ghcr.io/octoprint/custopizer

jobs:
  build:
    name: "🏗 Build"

    runs-on: ubuntu-latest

    outputs:
      tag: ${{ steps.meta.outputs.tags[0] }}
      digest: ${{ steps.docker_build.outputs.digest }}

    permissions:
      contents: read
      packages: write
      attestations: write
      id-token: write
  
    steps:
    - name: "⬇ Checkout"
      uses: actions/checkout@v4

    - name: "🐳 Login to GHCR"
      uses: docker/#-action@v3
      with:
        registry: ghcr.io
        username: ${{ github.repository_owner }}
        password: ${{ secrets.GITHUB_TOKEN }}

    - name: 🔍️ Determine metadata
      id: meta
      uses: docker/metadata-action@v5
      with:
        images: ${{ env.IMAGE_NAME }}
  
    - name: "🐳 Set up Docker Buildx"
      uses: docker/setup-buildx-action@v3

    - name: "🏗 Build & push by digest"
      id: docker_build
      uses: docker/build-push-action@v6
      with:
        context: ./src
        platforms: linux/amd64,linux/arm64

        # metadata
        labels: ${{ steps.meta.outputs.labels }}

        # inline cache
        cache-from: type=registry,ref=${{ env.IMAGE_NAME }}:${{ env.DOCKER_METADATA_OUTPUT_VERSION }}
        cache-to: type=inline

        # export
        outputs: type=image,"name=${{ env.IMAGE_NAME }}",push-by-digest=true,name-canonical=true,push=true


  test:
    name: "🧪 Test"
    needs: build

    strategy:
      fail-fast: false
      matrix:
        os: [ "ubuntu-latest", "ubuntu-22.04-arm" ]
        arch: [ "armhf", "arm64" ]

    runs-on: "${{ matrix.os }}"

    steps:
      - name: "⬇ Checkout"
        uses: actions/checkout@v4

      - name: "🛠 Prepare workspace with a fresh RPi lite image"
        shell: bash
        run: |
          DOWNLOAD_URL="https://downloads.raspberrypi.org/raspios_lite_${{ matrix.arch }}_latest.torrent"
          HASH_URL="https://downloads.raspberrypi.org/raspios_lite_${{ matrix.arch }}_latest.sha256"

          mkdir -p workspace
          cd workspace

          aria2c -d . --seed-time=0 "$DOWNLOAD_URL"

          # verify checksum
          curl -Ls $HASH_URL | sha256sum -c

          # search for the image file
          IMG_FILE=$(ls *.img.xz | head -n 1)
          echo "Found compressed Image file: ${IMG_FILE}"

          # extract the image file
          xz -d "${IMG_FILE}"

          DECOMPRESSED_FILE="${IMG_FILE%.xz}"
          echo "Image file: ${DECOMPRESSED_FILE}"

          # rename the image file
          mv "${DECOMPRESSED_FILE}" input.img

      - name: "🛠 Prepare test scripts"
        shell: bash
        run: |
          mkdir -p scripts

          cp .github/tests/00-hello-world scripts/

      - name: 🧪 Perform test build
        shell: bash
        run: |
          sudo modprobe loop

          case "${{ matrix.arch }}" in
            arm64)
              EDITBASE_ARCH="arm64"
              ;;
            
            *)
              EDITBASE_ARCH="armv7l"
              ;;
          esac

          IMAGE="${{ env.IMAGE_NAME }}@${{ needs.build.outputs.digest }}"
          COMMAND="--rm --privileged -e EDITBASE_ARCH=$EDITBASE_ARCH -v ${{ github.workspace }}/workspace:/CustoPiZer/workspace -v ${{ github.workspace }}/scripts:/CustoPiZer/workspace/scripts $IMAGE"

          echo "About to execute 'docker run $COMMAND'..."
          docker run $COMMAND

  deploy:
    name: "📦 Deploy"
    needs: 
    - build
    - test
    runs-on: "ubuntu-latest"

    if: github.event_name != 'pull_request'

    permissions:
      contents: read
      packages: write
      attestations: write
      id-token: write

    steps:
      - name: "🐳 Login to GHCR"
        uses: docker/#-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}
  
      - name: 🔍️ Determine metadata
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ env.IMAGE_NAME }}

      - name: "📦️ Tag image in registry"
        run: |
          IMAGE="${{ env.IMAGE_NAME }}@${{ needs.build.outputs.digest }}"
          TAGS=$(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON")

          docker buildx imagetools create $TAGS $IMAGE