-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add script to automatically publish readme to docker hub #6118
Open
inosmeet
wants to merge
8
commits into
jaegertracing:main
Choose a base branch
from
inosmeet:docker
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+128
−0
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
fc2bd08
feat: add script to automatically publish readme to docker hub
inosmeet 176ead2
fix: lint check
inosmeet 274d927
fix: lint checks
inosmeet e928295
feat: requested changes
inosmeet d979d71
test: upload-docker-readme
inosmeet 9a72a2c
fix: lint checks
inosmeet dbb20bc
feat: add support for quay
inosmeet d6b47b3
feat: requested changes
inosmeet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
#!/bin/bash | ||
|
||
# Copyright (c) 2024 The Jaeger Authors. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
set -euxf -o pipefail | ||
|
||
usage() { | ||
echo "Usage: $0 <repository_name> <file_path>" | ||
exit 1 | ||
} | ||
|
||
if [ "$#" -ne 2 ]; then | ||
echo "Error: Missing arguments." | ||
usage | ||
fi | ||
|
||
repo="$1" | ||
yurishkuro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
readme_path="$2" | ||
abs_readme_path=$(realpath "$readme_path") | ||
repository="jaegertracing/$repo" | ||
|
||
DOCKERHUB_TOKEN=${DOCKERHUB_TOKEN:?'missing Docker Hub token'} | ||
QUAY_TOKEN=${QUAY_TOKEN:?'missing Quay token'} | ||
|
||
dockerhub_url="https://hub.docker.com/v2/repositories/$repository/" | ||
quay_url="https://quay.io/api/v1/repository/${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 | ||
|
||
# Handling DockerHUB upload | ||
# encode readme as properly escaped JSON | ||
body=$(jq -n \ | ||
yurishkuro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--arg full_desc "$readme_content" \ | ||
'{full_description: $full_desc}') | ||
yurishkuro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
dockerhub_response=$(curl -s -w "%{http_code}" -X PATCH "$dockerhub_url" \ | ||
-H "Content-Type: application/json" \ | ||
-H "Authorization: JWT $DOCKERHUB_TOKEN" \ | ||
-d "$body") | ||
|
||
http_code="${dockerhub_response: -3}" | ||
response_body="${dockerhub_response:0:${#dockerhub_response}-3}" | ||
|
||
if [ "$http_code" -eq 200 ]; then | ||
echo "Successfully updated Docker Hub README for $repository" | ||
else | ||
echo "Failed to update Docker Hub README for $repository with status code $http_code" | ||
echo "Full response: $response_body" | ||
fi | ||
|
||
# Handling Quay upload | ||
# encode readme as properly escaped JSON | ||
quay_body=$(jq -n \ | ||
--arg full_desc "$readme_content" \ | ||
'{description: $full_desc}') | ||
|
||
quay_response=$(curl -s -w "%{http_code}" -X PUT "$quay_url" \ | ||
-H "Content-Type: application/json" \ | ||
-H "Authorization: Bearer $QUAY_TOKEN" \ | ||
-d "$quay_body") | ||
|
||
quay_http_code="${quay_response: -3}" | ||
quay_response_body="${quay_response:0:${#quay_response}-3}" | ||
|
||
if [ "$quay_http_code" -eq 200 ]; then | ||
echo "Successfully updated Quay.io README for $repository" | ||
else | ||
echo "Failed to update Quay.io README for $repository with status code $quay_http_code" | ||
echo "Full response: $quay_response_body" | ||
fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
#!/bin/bash | ||
|
||
# Copyright (c) 2024 The Jaeger Authors. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
set -euo pipefail | ||
|
||
# Mock variables | ||
dockerhub_repository="jaegertracing/test-docker" | ||
http_code="" | ||
response_body="" | ||
|
||
simulate_update() { | ||
local status=$1 | ||
if [ "$status" -eq 200 ]; then | ||
http_code=200 | ||
response_body="Successfully updated README." | ||
else | ||
http_code="$status" | ||
response_body="Error: Unable to update README." | ||
fi | ||
} | ||
|
||
# Test 1: Successful update | ||
echo "Running test: Successful update" | ||
simulate_update 200 | ||
if [ "$http_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 $http_code" | ||
echo "Full response: $response_body" | ||
fi | ||
|
||
# Test 2: Failed update | ||
echo "Running test: Failed update" | ||
simulate_update 403 | ||
if [ "$http_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 $http_code" | ||
echo "Full response: $response_body" | ||
fi |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: enclose in echo group as below, to collapse the logs