feat(factories): mark the steps of a build with "==>"

cuos-release/tool.sh puts a build's technical output in output/NAME.build.log
and passes lines carrying this marker through to the terminal. All the factories
have to do is say where they are; the separating happens over there, which is
why set -ex and both Dockerfiles stay as they are.

Nothing else changes: the trace of the echo itself does not match the anchored
marker on the other side, and a factory run directly just gets a prefix on six
of its lines.

prepare_iso.sh is left alone - it runs at docker build time, so its output only
ever reaches the CI job that publishes the image.

Not run: no factory image was built from this. The step lines were checked
against tool.sh with a stub mirroring these scripts.

Signed-off-by: Simon Walz <contact@simonwalz.de>

Author: simonwalz

image-factory/create_image.sh

@@ -6,6 +6,14 @@ raise() {
 	exit 1
 }
 
+# One line per step of the build, marked for whoever is running this factory.
+# cuos-release/tool.sh passes lines carrying this marker through to the terminal
+# and puts everything else in output/NAME.build.log; run directly, the marker is
+# just a prefix. Keep it in step with log_is_step_line() over there.
+step() {
+	echo "==> $*"
+}
+
 cleanup() {
 	# Versuche, gemountete Partitionen zu unmounten
 	umount -R /mnt/os 2>/dev/null || true
@@ -108,13 +116,15 @@ if [[ "${OS_ARCH}" == "lxc" ]]; then
   IMAGE="${IMAGE/img/tar.gz}"
   SLOT="A"
 
+  step "Fetching the system image ${OS_IMAGE}"
   docker image pull "${OS_IMAGE}" || raise "Faild to fetch image"
   IMAGE_DIGEST="$(docker inspect --format='{{index .RepoDigests 0}}' "${OS_IMAGE}" 2>/dev/null | cut -d '@' -f 2)"
   if [[ -n "${OS_DIGEST}" && "${OS_DIGEST}" != "${IMAGE_DIGEST}" ]]; then
     echo "Image digest mismatch: ${OS_DIGEST} != ${IMAGE_DIGEST}"
     exit 1
   fi
 
+  step "Initialising the system"
   CONTAINER_NAME="cuos-lxc-$$"
   docker run -it -d \
     --pull=never \
@@ -126,13 +136,14 @@ if [[ "${OS_ARCH}" == "lxc" ]]; then
   docker cp "${CONFIG_PATH}" "${CONTAINER_NAME}:/system_init.json" \
     || raise "Failed to copy system.json"
 
+  step "Exporting the root filesystem"
   if ! docker export "${CONTAINER_NAME}" | gzip >"${IMAGE}"; then
     raise "Failed to export the container"
   fi
   docker rm -f "${CONTAINER_NAME}" \
     || raise "Failed to remove the container"
 
-  echo "Image created at ${IMAGE/\//}"
+  step "${IMAGE/\//} written"
   exit 0
 fi
 
@@ -146,10 +157,11 @@ fi
 SIZE_MB="$(jq --arg size_mb "${SIZE_MB}" -r '.image_size_mb // $size_mb' "${CONFIG_PATH}")"
 
 # Create empty image
-echo "Create empty image:"
+step "Creating an empty image of ${SIZE_MB} MB"
 dd if=/dev/zero of="${IMAGE}" bs=1M count="${SIZE_MB}"
 sync
 
+step "Partitioning for '${TARGET}'"
 if [[ "${TARGET}" == "rpi" ]]; then
   parted "${IMAGE}" --script \
     mklabel msdos \
@@ -280,6 +292,7 @@ TARGET_ROOT_PARTITION="/dev/mapper/$(basename "${LOOPDEV}")p${TARGET_ROOT_PARTIT
 export TARGET_ROOT_PARTITION
 
 # Format partitions
+step "Creating the filesystems"
 mkfs.vfat -n boot "${TARGET_BOOT_PARTITION}" \
     || raise "Failed to format boot partition: ${TARGET_BOOT_PARTITION}"
 mkfs.btrfs -L system "${TARGET_ROOT_PARTITION}" \
@@ -297,6 +310,7 @@ mkdir -p /mnt/root/@data/log
 umount /mnt/root
 
 
+step "Installing the system from ${OS_IMAGE}"
 export INSTALLIMAGE=true
 /usr/local/updater/updater.sh \
 	"${SLOT}" \
@@ -315,7 +329,7 @@ if [[ "${EXITCODE}" != "0" ]]; then
 	raise "Failed to run updater script"
 fi
 
-echo "Image created at ${IMAGE/\//}"
+step "${IMAGE/\//} written"
 
 
 # File formats:

installer-factory/create_iso.sh

@@ -3,6 +3,14 @@
 
 set -ex
 
+# One line per step of the build, marked for whoever is running this factory.
+# cuos-release/tool.sh passes lines carrying this marker through to the terminal
+# and puts everything else in output/NAME.build.log; run directly, the marker is
+# just a prefix. Keep it in step with log_is_step_line() over there.
+step() {
+  echo "==> $*"
+}
+
 VOLID="CUOS"
 WORKDIR="/build"
 ISO_DIR="${WORKDIR}/iso"
@@ -30,6 +38,7 @@ export CONFIG_PATH="${OUTPUT_DIR}/${IMAGE_NAME}.json"
 
 # compress image using zstd (multi-threaded, level 9) and copy to the ISO dir
 # choose level 9 as a balance between compression ratio and build time; adjust as desired
+step "Compressing the system image"
 zstd -T0 -9 -c "${IMAGE}" > "${ISO_DIR}/image.img.zst"
 
 PRODUCT_NAME="CuOS"
@@ -50,12 +59,12 @@ if [[ -f "${CONFIG_PATH}" ]]; then
   fi
 fi
 
+step "Building the bootable ISO"
 grub-mkrescue \
   -o "${INSTALLER}" \
   -V "${VOLID}" \
   -iso-level 3 \
   -full-iso9660-filenames \
   "${ISO_DIR}" || exit 1
 
-echo "ISO creation complete."
-echo "Installer written to ${INSTALLER/\//}"
+step "${INSTALLER/\//} written"

installer-factory/patch_iso.sh

@@ -13,6 +13,14 @@
 
 set -ex
 
+# One line per step of the build, marked for whoever is running this factory.
+# cuos-release/tool.sh passes lines carrying this marker through to the terminal
+# and puts everything else in output/NAME.build.log; run directly, the marker is
+# just a prefix. Keep it in step with log_is_step_line() over there.
+step() {
+  echo "==> $*"
+}
+
 OUTPUT_DIR="/output"
 
 if [[ ! -d "${OUTPUT_DIR}" ]]; then
@@ -47,6 +55,7 @@ fi
 
 #xorriso -indev /output/CuOS-IaC-cuos-test.iso -ls /
 
+step "Replacing the configuration in the ISO"
 xorriso \
   -indev "${BASE_INSTALLER}" \
   -outdev "${INSTALLER}" \
@@ -55,5 +64,4 @@ xorriso \
   -compliance no_emul_toc \
   -padding included
 
-echo "ISO patching complete."
-echo "Installer written to ${INSTALLER/\//}"
+step "${INSTALLER/\//} written"