You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
DevOps-Bash-tools/docker/dockerhub_repo_set_readme.sh

68 lines
1.7 KiB
Bash

#!/usr/bin/env bash
# vim:ts=4:sts=4:sw=4:et
#
# Author: Hari Sekhon
# Date: 2022-04-22 17:36:34 +0100 (Fri, 22 Apr 2022)
#
# https://github.com/HariSekhon/DevOps-Bash-tools
#
# License: see accompanying Hari Sekhon LICENSE file
#
# If you're using my code you're welcome to connect with me on LinkedIn and optionally send me feedback to help steer this or other code I publish
#
# https://www.linkedin.com/in/HariSekhon
#
set -euo pipefail
[ -n "${DEBUG:-}" ] && set -x
srcdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck disable=SC1090,SC1091
. "$srcdir/lib/utils.sh"
# shellcheck disable=SC2034,SC2154
usage_description="
Sets the full README description of a DockerHub.com repo via the DockerHub API
Useful to sync GitHub README to DockerHub README
Uses the adajcent script dockerhub_api.sh, see there for authentication details
\$CURL_OPTS can be set to provide extra arguments to curl
Example:
${0##*/} HariSekhon/my-repo my new readme description
If no second arg is given, will read repo description from standard input
cat README.md | ${0##*/} HariSekhon/my-repo
"
# used by usage() in lib/utils.sh
# shellcheck disable=SC2034
usage_args="<owner/repo> [<description>]"
help_usage "$@"
min_args 1 "$@"
owner_repo="$1"
description="${*:2}"
if [ $# -lt 2 ]; then
echo "reading repo full description from stdin" >&2
description="$(cat)"
fi
timestamp "Setting DockerHub repo '$owner_repo' description to '$description'"
# don't URL encode this as it's inside JSON
#description="$("$srcdir/../bin/urlencode.sh" <<< "$description")"
# just strip quotes to protect the JSON
description="${description//\"/}"
"$srcdir/dockerhub_api.sh" "/repositories/$owner_repo" -X PATCH --data "{ \"full_description\": \"$description\" }"