feat: Add build-container-image action (#3)

* feat: Add build-container-image action for generic container builds

* chore: Correct the input description

Author: NickLarsenNZ

README.md

@@ -17,6 +17,41 @@ particular step in a workflow.
 | Image Repo Digest                  | `docker.stackable.tech/stackable/kafka@sha256:917f800259ef4915f976...` |
 | Digest                             | `sha256:917f800259ef4915f976e93987b752fd64debf347568610d7f685d2022...` |
 
+## `build-container-image`
+
+> Manifest: [build-container-image/action.yml][build-container-image]
+
+This action builds a *single* container image using `docker buildx build`. It does the following work:
+
+1. Free disk space to avoid running out of disk space during larger builds.
+2. Build the image using `docker buildx build`, outputting the architecture specific tag.
+
+This action is considered to be the **single** source of truth regarding the image manifest tag.
+All subsequent tasks must use this value to ensure consistency.
+
+### Inputs and Outputs
+
+> [!TIP]
+> For descriptions of the inputs and outputs, see the complete [build-container-image] action.
+
+#### Inputs
+
+- `image-name`
+- `image-index-manifest-tag`
+- `container-file` (defaults to `Dockerfile`)
+- `build-context` (defaults to `.`)
+<!--
+TODO (@NickLarsenNZ): Allow optional buildx cache
+- `build-cache-username`
+- `build-cache-password`
+-->
+
+#### Outputs
+
+- `image-manifest-tag`
+
+[build-container-image]: ./build-container-image/action.yml
+
 ## `build-product-image`
 
 > Manifest: [build-product-image/action.yml][build-product-image]

build-container-image/action.yml

@@ -0,0 +1,88 @@
+---
+name: Build Product Image
+description: This action builds a product Docker image with a specific version
+inputs:
+  image-name:
+    description: |
+      The local name of the built image, for example: `kafka` or
+      `csi-provisioner`
+    required: true
+  image-index-manifest-tag:
+    description: |
+      Human-readable tag (usually the version) without architecture information,
+      for example: `3.4.1-stackable0.0.0-dev`
+  container-file:
+    description: Path to Containerfile (or Dockefile)
+    default: Dockerfile
+  build-context:
+    description: Path to the build-context
+    default: .
+  # TODO (@NickLarsenNZ): Allow optional buildx cache
+  # build-cache-username:
+  #   description: Build cache username
+  #   default: github
+  # build-cache-password:
+  #   description: Build cache password
+  #   required: true
+outputs:
+  image-manifest-tag:
+    description: |
+      Human-readable tag (usually the version) with architecture information,
+      for example: `3.4.1-stackable0.0.0-dev-amd64`
+    value: ${{ steps.build-image.outputs.IMAGE_MANIFEST_TAG }}
+runs:
+  using: composite
+  steps:
+    - name: Free Disk Space (Ubuntu)
+      uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1
+      with:
+        # This might remove tools that are actually needed, if set to "true" but
+        # frees about 6 GB.
+        tool-cache: false
+
+        # All of these default to true, but feel free to set to "false" if
+        # necessary for your workflow.
+        android: true
+        dotnet: true
+        haskell: true
+        large-packages: true
+        docker-images: true
+        swap-storage: true
+
+    - name: Setup Docker Buildx
+      uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1
+
+    # TODO (@NickLarsenNZ): Allow optional buildx cache
+    #   # Needed if you pass the --cache argument to the bake command below
+    # - name: Login to the docker build cache registry
+    #   uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+    #   with:
+    #     registry: build-repo.stackable.tech:8083
+    #     username: ${{ inputs.build-cache-username }}
+    #     password: ${{ inputs.build-cache-password }}
+
+    - name: Build ${{ inputs.image-name }}:${{ inputs.image-index-manifest-tag }}
+      id: build-image
+      env:
+        IMAGE_NAME: ${{ inputs.image-name }}
+        IMAGE_INDEX_MANIFEST_TAG: ${{ inputs.image-index-manifest-tag }}
+        CONTAINER_FILE: ${{ inputs.container-file }}
+        BUILD_CONTEXT: ${{ inputs.build-context }}
+      shell: bash
+      run: |
+        set -euo pipefail
+
+        IMAGE_ARCH="$(uname -m | sed -e 's#x86_64#amd64#' | sed -e 's#aarch64#arm64#')"
+        echo "IMAGE_ARCH=${IMAGE_ARCH}" | tee -a "$GITHUB_ENV"
+
+        IMAGE_MANIFEST_TAG="${IMAGE_INDEX_MANIFEST_TAG}-${IMAGE_ARCH}"
+        echo "IMAGE_MANIFEST_TAG=${IMAGE_MANIFEST_TAG}" | tee -a $GITHUB_OUTPUT
+
+        docker buildx build \
+        --file "${CONTAINER_FILE}" \
+        --platform "linux/${IMAGE_ARCH}" \
+        --tag "localhost/${IMAGE_NAME}:${IMAGE_MANIFEST_TAG}" \
+        # TODO (@NickLarsenNZ): Allow optional buildx cache
+        # --cache-to ... \
+        # --cache-from ... \
+        "${BUILD_CONTEXT}"

publish-image/action.yml

@@ -13,7 +13,7 @@ inputs:
     required: true
   image-repository:
     description: |
-      Last segment of the path, for example `stackable/kafka` or
+      Path to the image, for example `stackable/kafka` or
       `k8s/sig-storage/csi-provisioner`
     required: true
   image-manifest-tag: