feat: add script to automatically publish readme to docker hub #6118
Conversation
Signed-off-by: Meet Soni <[email protected]>
Signed-off-by: Meet Soni <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6118 +/- ##
==========================================
- Coverage 96.48% 96.45% -0.03%
==========================================
Files 352 352
Lines 19973 20007 +34
==========================================
+ Hits 19270 19297 +27
- Misses 520 526 +6
- Partials 183 184 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Meet Soni <[email protected]>
|
|
| @@ -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 | |||
There was a problem hiding this comment.
+1 for having separate script!
I would prefer this to be called after the Docker image upload was successful. You can set a flag here and call the script after docker buildx build below
| readme_path="$2" | ||
| abs_readme_path=$(realpath "$readme_path") | ||
|
|
||
| DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:-} |
There was a problem hiding this comment.
| DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:-} | |
| DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:?'missing Docker Hub token'} |
|
|
||
| DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:-} | ||
| dockerhub_repository="jaegertracing/$repo" | ||
| dockerhub_url="https://hub.docker.com/v2/repositories/$dockerhub_repository/" |
There was a problem hiding this comment.
Q: what is the story with the other registries? E.g. we also push to quay.io - does it support similar API for updating the readme?
| # Copyright (c) 2024 The Jaeger Authors. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| set -euxf -o pipefail | ||
| repo="$1" |
There was a problem hiding this comment.
nit: add check for number of arguments and log error / usage if args missing
|
|
||
| body=$(jq -n \ | ||
| --arg full_desc "$readme_content" \ | ||
| '{full_description: $full_desc}') |
|
|
||
| set +x | ||
|
|
||
| body=$(jq -n \ |
There was a problem hiding this comment.
| body=$(jq -n \ | |
| # encode readme as properly escaped JSON | |
| body=$(jq -n \ |
| -H "Authorization: JWT $DOCKERHUB_TOKEN" \ | ||
| -d "$body") | ||
|
|
||
| dockerhub_status_code="$dockerhub_response" |
There was a problem hiding this comment.
what are you trying to achieve with this assignment?
| --arg full_desc "$readme_content" \ | ||
| '{full_description: $full_desc}') | ||
|
|
||
| dockerhub_response=$(curl -s -o /dev/null -w "%{http_code}" -X PATCH "$dockerhub_url" \ |
There was a problem hiding this comment.
-o /dev/null
Will it not swallow the output / response, especially in case of an error?
| 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" |
There was a problem hiding this comment.
can you include in the description a test that hits this point, to show how the logs look?
Which problem is this PR solving?
Fixes: #3842
Description of the changes
How was this change tested?
Checklist
jaeger:make lint test