ci(release): setup docker multi-arch build (#49)

Author: Djaytan

.github/renovate.json5

@@ -58,12 +58,11 @@
 
       // Matchers
       fileMatch: [
-        'src\\/build\\/get-papermc-server\\.sh$',
-        '.github\\/semantic-release\\/release\\.sh$'
+        '(^|\\/)docker-bake\\.hcl$'
       ],
       matchStrings: [
         // cf. https://regex101.com/r/SLgTRk
-        '# renovate: datasource=papermc\\s+MINECRAFT_VERSION=["\']?(?<currentValue>.+?)["\']?\\s'
+        '# renovate: datasource=papermc\\s+variable "MINECRAFT_VERSION" {\\s+default = "(?<currentValue>.+?)"\\s+}'
       ]
     }
   ]

.github/semantic-release/release.sh

@@ -2,34 +2,26 @@
 
 set -Eeuo pipefail
 
-NEXT_RELEASE_VERSION=$1
-NEXT_RELEASE_CHANNEL=${2:-default}
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd -P)
 
-# Extract <major>.<minor> part of the SemVer version
-NEXT_RELEASE_MAJOR_MINOR_VERSION="${NEXT_RELEASE_VERSION%".${NEXT_RELEASE_VERSION#*.*.}"}"
-# Extract <major> part of the SemVer version
-NEXT_RELEASE_MAJOR_VERSION="${NEXT_RELEASE_MAJOR_MINOR_VERSION%.*}"
+RELEASE_VERSION=$1
+RELEASE_CHANNEL=${2:-'default'}
 
-# renovate: datasource=papermc
-MINECRAFT_VERSION='1.21.4'
-
-IMAGE_NAME=djaytan/papermc-server
-IMAGE_BUILD_CONTEXT_DIR="$ROOT_PROJECT_DIR/src"
-
-docker info
-docker build --platform=linux/amd64,linux/arm64 --tag "$IMAGE_NAME" "$IMAGE_BUILD_CONTEXT_DIR"
-
-# Docker tag format: <mc-version>-v<image-version>-<timestamp-YYYYMMDD>
-docker tag "$IMAGE_NAME" "$IMAGE_NAME:$MINECRAFT_VERSION"
-docker tag "$IMAGE_NAME" "$IMAGE_NAME:$MINECRAFT_VERSION-v$NEXT_RELEASE_VERSION"
-docker tag "$IMAGE_NAME" "$IMAGE_NAME:$MINECRAFT_VERSION-v$NEXT_RELEASE_MAJOR_MINOR_VERSION"
-docker tag "$IMAGE_NAME" "$IMAGE_NAME:$MINECRAFT_VERSION-v$NEXT_RELEASE_MAJOR_VERSION"
-docker tag "$IMAGE_NAME" "$IMAGE_NAME:$MINECRAFT_VERSION-v$NEXT_RELEASE_VERSION-$(date +%Y%m%d)"
+export REGISTRY='docker.io'
+export BUILD_CONTEXT="$SCRIPT_DIR"
+export IMAGE_VERSION="$RELEASE_VERSION"
 
 # The default channel binds to the default Git branch (i.e. "main")
 # If we release from "main" branch -> we add the "latest" tag
-if [[ "$NEXT_RELEASE_CHANNEL" == 'default' ]]; then
-  docker tag "$IMAGE_NAME" "$IMAGE_NAME:latest"
+IS_LATEST_RELEASE="$([ "$RELEASE_CHANNEL" == 'default' ] && echo 'true' || echo 'false')"
+export IS_LATEST_RELEASE
+
+if [[ -z "$ROOT_PROJECT_DIR" ]]; then
+  echo 'Error: environment variable "ROOT_PROJECT_DIR" is not set.'
+  exit 1
 fi
 
-docker push --all-tags "$IMAGE_NAME"
+cd "$ROOT_PROJECT_DIR/src"
+
+docker buildx bake release --print
+docker buildx bake release --push

.github/workflows/ci.yml

@@ -11,6 +11,10 @@ on:
 
 permissions: {}
 
+# TODO: rework CI - Use the test.sh script and rely on the generated tag
+# TODO: fail if container run fails
+# TODO: do we want to test multi-arch build?
+# TODO: what about cache?
 jobs:
   build-and-test:
     name: Build & Test

.github/workflows/release.yaml .github/workflows/release.yml.github/workflows/release.yaml renamed to .github/workflows/release.yml

@@ -1,5 +1,6 @@
 name: Release
 
+# TODO: frequent releases (once per week or at push time)
 on:
   workflow_dispatch:
 
@@ -43,6 +44,7 @@ jobs:
             production.cloudflare.docker.com:443
             archive.ubuntu.com:80
             security.ubuntu.com:80
+            ports.ubuntu.com:80
             api.papermc.io:443
             api.nuget.org:443
             registry.npmjs.org:443
@@ -72,8 +74,10 @@ jobs:
 
       # Setup of QEMU x Buildx
       # Required for multi-arch builds (typically for ARM architecture support)
+      # TODO: rely on native ARM64 native node instead of QEMU: https://docs.docker.com/build/ci/github-actions/multi-platform/
       - name: Set up QEMU
         uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0
 

src/Dockerfile

@@ -16,6 +16,15 @@
 
 FROM docker.io/ubuntu:noble@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782 AS build
 
+ARG MINECRAFT_VERSION
+
+RUN if [[ -z "$MINECRAFT_VERSION" ]]; then \
+        echo "Error: MINECRAFT_VERSION argument is not set." >&2; \
+        exit 1; \
+    fi
+
+RUN echo "Building PaperMC server for Minecraft version: $MINECRAFT_VERSION"
+
 WORKDIR /build
 
 # Install required dependencies
@@ -27,7 +36,7 @@ RUN apt-get update && \
 
 # Retrieve latest Paper server for the given version
 COPY --chmod=500 build/get-papermc-server.sh .
-RUN ./get-papermc-server.sh
+RUN ./get-papermc-server.sh "$MINECRAFT_VERSION"
 
 FROM docker.io/eclipse-temurin:21-jre-noble@sha256:3ef64ec531571987f58ccc90bd3d7f92950539f1baa00a5c45b660d6faccf37d
 
@@ -56,6 +65,7 @@ WORKDIR /home/papermc
 COPY --from=build --chown=papermc --chmod=500 /build/papermc-server-*.jar ./
 
 # Copy license file
+# TODO: rely on named build context instead: https://docs.docker.com/build/concepts/context/#named-contexts
 ADD --chmod=444 https://raw.githubusercontent.com/Djaytan/docker-papermc-server/refs/heads/main/LICENSE.md .
 
 # Copy the configuration files

src/build.sh

@@ -1,8 +1,7 @@
 #!/usr/bin/env bash
 # Reference: https://docs.papermc.io/misc/downloads-api
 
-# renovate: datasource=papermc
-MINECRAFT_VERSION='1.21.4'
+MINECRAFT_VERSION=$1
 
 LATEST_BUILD=$(curl -sSf "https://api.papermc.io/v2/projects/paper/versions/${MINECRAFT_VERSION}/builds" | \
     jq -r '.builds | map(select(.channel == "default") | .build) | .[-1]')

src/build/get-papermc-server.sh

@@ -0,0 +1,77 @@
+# ========== VARIABLES ========== #
+
+# General properties
+variable "REGISTRY" {
+  default = ""
+}
+variable "IMAGE_NAME" {
+  # TODO: make organization configurable
+  default = "djaytan/papermc-server"
+}
+
+# Tags properties
+variable "IS_LATEST_RELEASE" {
+  default = false
+}
+# renovate: datasource=papermc
+variable "MINECRAFT_VERSION" {
+  default = "1.21.4"
+}
+variable "IMAGE_VERSION" {
+  default = "$IMAGE_VERSION"
+}
+
+# ========== FUNCTIONS ========== #
+
+function "tag" {
+  params = [tag]
+  result = "${notequal(REGISTRY, "") ? "${REGISTRY}/" : ""}${IMAGE_NAME}:${tag}"
+}
+
+function "extractMajorFromSemVer" {
+  params = [semver]
+  result = split(".", semver)[0]
+}
+
+function "extractMajorMinorFromSemVer" {
+  params = [semver]
+  result = "${split(".", semver)[0]}.${split(".", semver)[1]}"
+}
+
+function "date" {
+  params = []
+  result = formatdate("YYYYMMDD", timestamp())
+}
+
+# ========== TARGETS ========== #
+
+target "dev" {
+  description = "Builds the image for development purposes."
+  args {
+    MINECRAFT_VERSION = "${MINECRAFT_VERSION}"
+  }
+  tags = [
+    tag("dev")
+  ]
+}
+
+target "release" {
+  description = "Builds the image for production purposes."
+  args {
+    MINECRAFT_VERSION = "${MINECRAFT_VERSION}"
+  }
+  platforms = ["linux/amd64", "linux/arm64"]
+  pull = true
+  no-cache = true
+  # Docker tag format: <mc-version>-v<image-version>-<timestamp-YYYYMMDD>
+  tags = [
+    equal(IS_LATEST_RELEASE, true) ? tag("latest") : "", # Optional latest tag (empty string = no tag)
+    tag("${MINECRAFT_VERSION}"),
+    tag("${MINECRAFT_VERSION}-v${IMAGE_VERSION}"),
+    tag("${MINECRAFT_VERSION}-v${IMAGE_VERSION}-${date()}"),
+    tag("${MINECRAFT_VERSION}-v${extractMajorMinorFromSemVer(IMAGE_VERSION)}"),
+    tag("${MINECRAFT_VERSION}-v${extractMajorFromSemVer(IMAGE_VERSION)}")
+  ]
+  # TODO: annotations => https://github.com/opencontainers/image-spec/blob/main/annotations.md (or at Dockerfile level maybe?)
+  # TODO: what about labels?
+}