feat: automatically publish readme to docker hub

scripts/build-upload-a-docker-image.sh

@@ -107,6 +107,7 @@ else
 	    if [[ "$overwrite" == 'N' ]]; then
 	      check_overwrite "${IMAGE_TAGS[@]}"
 	    fi
+	    bash scripts/upload-docker-readme.sh "${component_name}" "${dir_arg}"/README.md
     else
 	    echo 'skipping docker images upload, because not on tagged release or main branch'
 	    PUSHTAG="type=image,push=false"

scripts/upload-docker-readme.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+set -euxf -o pipefail
+repo="$1"
+readme_path="$2"
+abs_readme_path=$(realpath "$readme_path")
+
+DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:-}
+dockerhub_repository="jaegertracing/$repo"
+dockerhub_url="https://hub.docker.com/v2/repositories/$dockerhub_repository/"
+
+if [ ! -f "$abs_readme_path" ]; then
+  echo "Warning: the dedicated README file for Docker image $repo was not found at path $abs_readme_path"
+  echo "It is recommended to have a dedicated README file for each Docker image"
+  exit 0
+fi
+
+readme_content=$(<"$abs_readme_path")
+
+set +x
+
+body=$(jq -n \
+  --arg full_desc "$readme_content" \
+  '{full_description: $full_desc}')
+
+dockerhub_response=$(curl -s -o /dev/null -w "%{http_code}" -X PATCH "$dockerhub_url" \
+    -H "Content-Type: application/json" \
+    -H "Authorization: JWT $DOCKERHUB_TOKEN" \
+    -d "$body")
+
+dockerhub_status_code="$dockerhub_response"
+
+if [ "$dockerhub_status_code" -eq 200 ]; then
+  echo "Successfully updated Docker Hub README for $dockerhub_repository"
+else
+  echo "Failed to update Docker Hub README for $dockerhub_repository with status code $dockerhub_status_code"
+  echo "Full response: $dockerhub_response"
+fi