format/remove dust and document

Author: dkijania

buildkite/scripts/release/manager.sh

@@ -1,5 +1,31 @@
 #!/usr/bin/env bash
 
+# Mina Protocol Release Manager Script
+# 
+# This script provides comprehensive release management functionality for the Mina Protocol project.
+# It handles the complete lifecycle of build artifacts including publishing, promotion, verification,
+# and maintenance of packages across different channels and platforms.
+#
+# Main capabilities:
+# - PUBLISH: Publish build artifacts from cache to Debian repositories and Docker registries
+# - PROMOTE: Promote artifacts from one channel/registry to another (e.g., unstable -> stable)
+# - VERIFY: Verify that artifacts are correctly published in target channels/registries
+# - FIX: Repair Debian repository manifests when needed
+# - PERSIST: Archive artifacts to long-term storage backends
+#
+# Supported artifacts: mina-daemon, mina-archive, mina-rosetta, mina-logproc
+# Supported networks: devnet, mainnet
+# Supported platforms: Debian (bullseye, focal), Docker (GCR, Docker.io)
+# Supported channels: unstable, alpha, beta, stable
+# Supported backends: Google Cloud Storage (gs), Hetzner, local filesystem
+#
+# Usage examples:
+#   ./manager.sh publish --buildkite-build-id 12345 --source-version 1.0.0 --target-version 1.0.1 --channel stable
+#   ./manager.sh promote --source-version 1.0.0 --target-version 1.0.1 --source-channel alpha --target-channel beta
+#   ./manager.sh verify --version 1.0.1 --channel stable --artifacts mina-daemon,mina-archive
+#
+# For detailed help on any command, use: ./manager.sh [command] --help
+
 # bash strict mode
 set -T # inherit DEBUG and RETURN trap for functions
 set -C # prevent file overwrite by > &> <>

scripts/docker/verify.sh

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
-set -x
+
+# Verify that the Docker image for a given package and version is working correctly.
+# This script pulls the Docker image and runs a set of simplest commands (fetch help and version) 
+# to ensure that the package dependencies are correctly resolved.
+# Usage: ./scripts/docker/verify.sh -p <package> -c <codename> [-s <suffix>] [-r <repo>] [-v <version>]
 
 set -eo pipefail
 
@@ -27,7 +31,7 @@ esac
 
 DOCKER_IMAGE="$REPO/$PACKAGE:$VERSION-${CODENAME}${SUFFIX}"
 
-if ! docker pull $DOCKER_IMAGE ; then
+if ! docker pull "$DOCKER_IMAGE" ; then
   echo "❌ Docker verification for $CODENAME $PACKAGE failed"
   echo "❌ Please check if the image $DOCKER_IMAGE exists."
   exit 1
@@ -36,7 +40,9 @@ fi
 for APP in "${APPS[@]}"; do
   for COMMAND in "${COMMANDS[@]}"; do
     echo "📋  Testing $APP $COMMAND in $DOCKER_IMAGE"
-    if ! docker run --entrypoint $APP --rm $DOCKER_IMAGE $COMMAND; then
+    # Do not quote $COMMAND, because it may contain spaces or other special characters
+    # shellcheck disable=SC2086
+    if ! docker run --entrypoint "$APP" --rm "$DOCKER_IMAGE" $COMMAND; then
       echo "❌  KO: ERROR running $APP $COMMAND"
       exit 1
     fi