Support for multi-platform builds (#32)

Support for multi-platform builds

Author: zdmytriv

.github/workflows/test-docker-build-multi-platform.yml

@@ -0,0 +1,64 @@
+name: Test docker multi-platform
+on:
+#  # Uncomment when test added first time to register workflow and comment it back after workflow would be registered
+#  #
+#  # Added pull_request to register workflow from the PR.
+#  # Read more https://stackoverflow.com/questions/63362126/github-actions-how-to-run-a-workflow-created-on-a-non-master-branch-from-the-wo
+#  pull_request: {}
+  workflow_dispatch: {}
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup
+        run: echo "Do setup"
+
+  test:
+    runs-on: ubuntu-latest
+    needs: [setup]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: ./
+        id: current
+        with:
+          workdir: ./test/custom
+          file: Dockerfile_multi_platform
+          organization: ${{ github.event.repository.owner.login }}
+          repository: ${{ github.event.repository.name }}
+          registry: registry.hub.docker.com
+          login: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          platforms: linux/amd64,linux/arm64
+
+      - uses: nick-fields/assert-action@v1
+        with:
+          expected: 'registry.hub.docker.com/cloudposse/github-action-docker-build-push'
+          actual: ${{ steps.current.outputs.image }}
+
+      - uses: nick-fields/assert-action@v1
+        with:
+          expected: sha-${{ github.sha }}
+          actual: ${{ steps.current.outputs.tag }}
+
+      - uses: nick-fields/assert-action@v1
+        with:
+          expected: 'containerimage.buildinfo/linux/amd64'
+          actual: ${{ steps.current.outputs.metadata }}
+          comparison: contains
+
+      - uses: nick-fields/assert-action@v1
+        with:
+          expected: 'containerimage.buildinfo/linux/arm64'
+          actual: ${{ steps.current.outputs.metadata }}
+          comparison: contains
+
+  teardown:
+    runs-on: ubuntu-latest
+    needs: [test]
+    if: ${{ always() }}
+    steps:
+      - name: Tear down
+        run: echo "Do Tear down"

README.md

@@ -90,6 +90,7 @@ Build Docker image and push it.
           repository: "${{ github.event.repository.name }}"
           login: "${{ secrets.DOCKERHUB_USERNAME }}"
           password: "${{ secrets.DOCKERHUB_PASSWORD }}"
+          platforms: linux/amd64,linux/arm64
 
     outputs:
       image: ${{ steps.build.outputs.image }}
@@ -102,25 +103,34 @@ Build Docker image and push it.
 
 
 <!-- markdownlint-disable -->
+
 ## Inputs
 
 | Name | Description | Default | Required |
 |------|-------------|---------|----------|
 | build-args | List of build-time variables | N/A | false |
+| cache-from | List of external cache sources for buildx (e.g., user/app:cache, type=local,src=path/to/dir) | type=gha | false |
+| cache-to | List of cache export destinations for buildx (e.g., user/app:cache, type=local,dest=path/to/dir) | type=gha,mode=max | false |
 | file | Dockerfile name | Dockerfile | false |
+| image\_name | Image name (excluding registry). Defaults to {{$organization/$repository}}. |  | false |
 | login | Docker login |  | false |
 | organization | Organization | N/A | true |
 | password | Docker password |  | false |
+| platforms | List of target platforms for build (e.g. linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,etc) | linux/amd64 | false |
 | registry | Docker registry | N/A | true |
 | repository | Repository | N/A | true |
+| ssh | List of SSH agent socket or keys to expose to the build | N/A | false |
 | tags | List of tags (supports https://github.com/docker/metadata-action#tags-input) | N/A | false |
+| target | Sets the target stage to build |  | false |
 | workdir | Working directory | ./ | false |
 
+
 ## Outputs
 
 | Name | Description |
 |------|-------------|
 | image | Docker image name |
+| metadata | Docker image metadata |
 | tag | Docker image tag |
 <!-- markdownlint-restore -->
 
@@ -219,7 +229,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 ## Copyright
 
-Copyright © 2017-2022 [Cloud Posse, LLC](https://cpco.io/copyright)
+Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
 
 
 

README.yaml

@@ -69,6 +69,7 @@ usage: |-
             repository: "${{ github.event.repository.name }}"
             login: "${{ secrets.DOCKERHUB_USERNAME }}"
             password: "${{ secrets.DOCKERHUB_PASSWORD }}"
+            platforms: linux/amd64,linux/arm64
 
       outputs:
         image: ${{ steps.build.outputs.image }}

action.yml

@@ -29,6 +29,10 @@ inputs:
     description: "Sets the target stage to build"
     required: false
     default: ''
+  platforms:
+    description: "List of target platforms for build (e.g. linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,etc)"
+    required: false
+    default: 'linux/amd64'
   image_name:
     description: "Image name (excluding registry). Defaults to {{$organization/$repository}}."
     required: false
@@ -62,6 +66,9 @@ outputs:
   tag:
     description: "Docker image tag"
     value: ${{ steps.tag.outputs.output }}
+  metadata:
+    description: "Docker image metadata"
+    value: ${{ steps.get-metadata.outputs.metadata }}
 
 runs:
   using: "composite"
@@ -113,6 +120,9 @@ runs:
       run: |
         docker context create buildx-context || true 
 
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v2
       with:
@@ -128,6 +138,7 @@ runs:
 
     - name: Build and push Docker images
       uses: docker/build-push-action@v3
+      id: docker-build-push-action
       with:
         context: ${{ inputs.workdir }}
         file: ${{ inputs.workdir }}/${{ inputs.file }}
@@ -140,3 +151,12 @@ runs:
         tags: ${{ steps.meta.outputs.tags }}
         target: ${{ inputs.target }}
         labels: ${{ steps.meta.outputs.labels }}
+        platforms: ${{ inputs.platforms }}
+
+    - name: Get Metadata
+      id: get-metadata
+      shell: bash
+      run: |
+        metadata=$(echo '${{ steps.docker-build-push-action.outputs.metadata }}' | jq -c)
+        echo "metadata=$metadata" >> $GITHUB_OUTPUT
+        echo "Docker image metadata: $metadata"

docs/github-action.md

@@ -1,22 +1,31 @@
 <!-- markdownlint-disable -->
+
 ## Inputs
 
 | Name | Description | Default | Required |
 |------|-------------|---------|----------|
 | build-args | List of build-time variables | N/A | false |
+| cache-from | List of external cache sources for buildx (e.g., user/app:cache, type=local,src=path/to/dir) | type=gha | false |
+| cache-to | List of cache export destinations for buildx (e.g., user/app:cache, type=local,dest=path/to/dir) | type=gha,mode=max | false |
 | file | Dockerfile name | Dockerfile | false |
+| image\_name | Image name (excluding registry). Defaults to {{$organization/$repository}}. |  | false |
 | login | Docker login |  | false |
 | organization | Organization | N/A | true |
 | password | Docker password |  | false |
+| platforms | List of target platforms for build (e.g. linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,etc) | linux/amd64 | false |
 | registry | Docker registry | N/A | true |
 | repository | Repository | N/A | true |
+| ssh | List of SSH agent socket or keys to expose to the build | N/A | false |
 | tags | List of tags (supports https://github.com/docker/metadata-action#tags-input) | N/A | false |
+| target | Sets the target stage to build |  | false |
 | workdir | Working directory | ./ | false |
 
+
 ## Outputs
 
 | Name | Description |
 |------|-------------|
 | image | Docker image name |
+| metadata | Docker image metadata |
 | tag | Docker image tag |
 <!-- markdownlint-restore -->

test/custom/Dockerfile_multi_platform

@@ -0,0 +1,10 @@
+FROM nginx:1.23.0-alpine
+
+ARG TARGETPLATFORM
+
+# Run commands based on the platform
+RUN if [ "$TARGETPLATFORM" = "linux/arm64" ]; then \
+        echo "This command only runs on ARM64-based platforms"; \
+    else \
+        echo "This command runs on all platforms"; \
+    fi