build-image.yml

---

on:  # yamllint disable-line rule:truthy
  workflow_call:
    inputs:
      os:
        description: The operating system to run the workflow on
        required: false
        type: string
        default: ubuntu-latest
      push-to-hub:
        description: Push the image to Docker Hub
        required: false
        type: boolean
        default: false
      image-namespace:
        description: 'The namespace of the image, example: wayofdev/php-base'
        required: true
        type: string
      image-template-path:
        description: 'The path to the template of the image, example: ./dist/base'
        required: true
        type: string
      image-template:
        description: 'The template of the image, example: 8.2-fpm-alpine'
        required: true
        type: string
      image-version:
        description: 'The version of the image, example: latest'
        required: true
        type: string
      image-platform:
        description: The platform of the image
        required: false
        type: string
        default: linux/amd64,linux/arm64
    secrets:
      docker-username:
        description: Docker Hub username
        required: true
      docker-password:
        description: Docker Hub password
        required: true

name: 🚀 Build docker images

jobs:
  build:
    runs-on: ${{ inputs.os }}
    steps:
      - name: 📦 Check out the codebase
        uses: actions/checkout@v4.2.2

      - name: 🛠️ Install goss and dgoss
        uses: e1himself/goss-installation-action@v1.2.1
        with:
          version: v0.4.6

      - name: 🤖 Generate dist files
        run: make generate

      - name: 🐳 Extract docker meta data
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ inputs.image-namespace }}
          tags: |
            type=raw,event=branch,value=latest
            type=ref,event=pr
            type=semver,pattern={{version}}
            type=semver,pattern={{major}}.{{minor}}
          flavor: |
            latest=false
            prefix=${{ inputs.image-template }}-

      - name: 🔑 Login to docker-hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.docker-username }}
          password: ${{ secrets.docker-password }}

      - name: 🖥️ Setup QEMU for "${{ inputs.image-platform }}"
        uses: docker/setup-qemu-action@v3
        with:
          platforms: ${{ inputs.image-platform }}

      - name: 🛠️ Setup docker BuildX for "${{ inputs.image-platform }}"
        uses: docker/setup-buildx-action@v3
        with:
          install: true
          platforms: ${{ inputs.image-platform }}

      - name: 🚀 Build image and push to docker-hub for "${{ inputs.image-platform }}"
        uses: docker/build-push-action@v6
        with:
          context: '${{ inputs.image-template-path }}/${{ inputs.image-template }}'
          platforms: ${{ inputs.image-platform }}
          push: ${{ inputs.push-to-hub == true }}
          tags: ${{ steps.meta.outputs.tags }}
          cache-from: type=registry,ref=${{ inputs.image-namespace }}:${{ inputs.image-template }}-cache
          cache-to: type=registry,ref=${{ inputs.image-namespace }}:${{ inputs.image-template }}-cache,mode=max
          labels: ${{ steps.meta.outputs.labels }}

      - name: 🧪 Test Docker image
        if: ${{ inputs.image-platform == 'linux/amd64' }}
        run: |
          export IMAGE_TEMPLATE=${{ inputs.image-template }}
          export IMAGE_TAG=${{ inputs.image-namespace }}:${{ inputs.image-template }}-${{ inputs.image-version }}
          make test

...