chore: store docker build result metadata (#2205)

Author: lemeurherve

.ci/publish.sh

@@ -76,15 +76,21 @@ else
 fi
 
 build_opts=("--pull")
+metadata_suffix="publish"
 if test "${dry_run}" == "true"; then
     build_opts+=("--load")
+    metadata_suffix="dry-run"
 else
     build_opts+=("--push")
 fi
 
+# Save build result metadata
+BUILD_METADATA_PATH="target/build-result-metadata_${metadata_suffix}.json"
+build_opts+=("--metadata-file=${BUILD_METADATA_PATH}")
+
 WAR_SHA="$(curl --disable --fail --silent --show-error --location "https://repo.jenkins-ci.org/releases/org/jenkins-ci/main/jenkins-war/${JENKINS_VERSION}/jenkins-war-${JENKINS_VERSION}.war.sha256")"
 COMMIT_SHA=$(git rev-parse HEAD)
-export COMMIT_SHA JENKINS_VERSION WAR_SHA LATEST_WEEKLY LATEST_LTS
+export COMMIT_SHA JENKINS_VERSION WAR_SHA LATEST_WEEKLY LATEST_LTS BUILD_METADATA_PATH
 
 cat <<EOF
 Using the following settings:
@@ -94,6 +100,7 @@ Using the following settings:
 * COMMIT_SHA: ${COMMIT_SHA}
 * LATEST_WEEKLY: ${LATEST_WEEKLY}
 * LATEST_LTS: ${LATEST_LTS}
+* BUILD_METADATA_PATH: ${BUILD_METADATA_PATH}
 EOF
 
 docker buildx bake --file docker-bake.hcl "${build_opts[@]}" linux

Jenkinsfile

@@ -149,6 +149,7 @@ stage('Build') {
                         stage("Build linux-${imageToBuild}") {
                             infra.withDockerCredentials {
                                 sh "make build-${imageToBuild}"
+                                archiveArtifacts artifacts: 'target/build-result-metadata_*.json', allowEmptyArchive: true
                             }
                         }
 
@@ -179,6 +180,7 @@ stage('Build') {
                         stage("Multi arch build - ${architecture}") {
                             infra.withDockerCredentials {
                                 sh "make docker-init buildarch-${architecture}"
+                                archiveArtifacts artifacts: 'target/build-result-metadata_*.json', allowEmptyArchive: true
                             }
                         }
                     }
@@ -206,6 +208,7 @@ stage('Build') {
                                     infra.withDockerCredentials {
                                         sh 'make docker-init'
                                         sh 'make publish'
+                                        archiveArtifacts artifacts: 'target/build-result-metadata_*.json', allowEmptyArchive: true
                                     }
                                 }
                             }

Makefile

@@ -34,6 +34,8 @@ check_cli = type "$(1)" >/dev/null 2>&1 || { echo "Error: command '$(1)' require
 check_image = make --silent list | grep -w '$(1)' >/dev/null 2>&1 || { echo "Error: the image '$(1)' does not exist in manifest for the platform 'linux/$(ARCH)'. Please check the output of 'make list'. Exiting." ; exit 1 ; }
 ## Base "docker buildx base" command to be reused everywhere
 bake_base_cli := docker buildx bake -f docker-bake.hcl --load
+## Default bake target
+bake_default_target := linux
 
 check-reqs:
 ## Build requirements
@@ -71,21 +73,21 @@ shellcheck:
 	@$(ROOT_DIR)/tools/shellcheck -e SC1091 jenkins-support *.sh tests/test_helpers.bash tools/hadolint tools/shellcheck .ci/publish.sh
 
 # Build targets depending on the current architecture
-build: check-reqs
-	@set -x; $(bake_base_cli) --set '*.platform=linux/$(ARCH)' $(shell make --silent list)
+build: check-reqs target
+	@set -x; $(bake_base_cli) --metadata-file=target/build-result-metadata_$(bake_default_target).json --set '*.platform=linux/$(ARCH)' $(shell make --silent list)
 
 # Build targets depending on the architecture
-buildarch-%: check-reqs showarch-%
-	@set -x; $(bake_base_cli) --set '*.platform=linux/$*' $(shell make --silent listarch-$*)
+buildarch-%: check-reqs target showarch-%
+	@set -x; $(bake_base_cli) --metadata-file=target/build-result-metadata_$*.json --set '*.platform=linux/$*' $(shell make --silent listarch-$*)
 
 # Build a specific target with the current architecture
-build-%: check-reqs show-%
+build-%: check-reqs target show-%
 	@$(call check_image,$*)
-	@set -x; $(bake_base_cli) --set '*.platform=linux/$(ARCH)' '$*'
+	@set -x; $(bake_base_cli) --metadata-file=target/build-result-metadata_$*.json --set '*.platform=linux/$(ARCH)' '$*'
 
 # Show all targets
 show:
-	@set -x; make --silent show-linux
+	@set -x; make --silent show-$(bake_default_target)
 
 # Show a specific target
 show-%:
@@ -117,9 +119,12 @@ bats:
 	cd bats ;\
 	git checkout 3bca150ec86275d6d9d5a4fd7d48ab8b6c6f3d87; # v1.13.0
 
-# Ensure all bats submodules are up to date and that the tests target folder exists
-prepare-test: bats check-reqs
+# Ensure all bats submodules are up to date
+prepare-test: bats check-reqs target
 	git submodule update --init --recursive
+
+# Ensure tests and build metadata "target" folder exist
+target:
 	mkdir -p target
 
 ## Define bats options based on environment
@@ -159,7 +164,7 @@ test: prepare-test
 	@make --silent list | while read image; do make --silent "test-$${image}"; done
 
 # Set all required variables and publish all targets
-publish:
+publish: target
 	./.ci/publish.sh
 
 clean: