style(scripts): harden add-annotations.sh to follow shell best practices
Apply shell scripting conventions to improve robustness and consistency:
- Enable `set -u` (nounset) to catch unset variable references early
- Add trap-based cleanup for temporary files instead of manual rm
- Use `readonly` for constants (CHART_FILE, RC_PATTERN)
- Replace `[ ]` with `[[ ]]` throughout for modern bash conditionals
- Use `read -r` to prevent backslash interpretation
- Use `${1:-}` / `${2:-}` for safe positional parameter access under nounset
- Normalize stderr redirect to `>&2`
- Remove `function` keyword, align `;;` in case statements
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
@@ -1,73 +1,85 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
set -eo pipefail
|
# ============================================================================
|
||||||
|
# Generate ArtifactHub changelog annotations from git commit history
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
CHART_FILE="Chart.yaml"
|
set -euo pipefail
|
||||||
if [ ! -f "${CHART_FILE}" ]; then
|
|
||||||
echo "ERROR: ${CHART_FILE} not found!" 1>&2
|
readonly CHART_FILE="Chart.yaml"
|
||||||
|
readonly RC_PATTERN="\-rc([-\.][0-9]+)?$"
|
||||||
|
|
||||||
|
CHANGE_LOG_YAML=""
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
if [[ -n "${CHANGE_LOG_YAML:-}" && -f "${CHANGE_LOG_YAML}" ]]; then
|
||||||
|
rm -f "${CHANGE_LOG_YAML}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
if [[ ! -f "${CHART_FILE}" ]]; then
|
||||||
|
echo "ERROR: ${CHART_FILE} not found!" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
rc_pattern="\-rc([-\.][0-9]+)?$"
|
|
||||||
|
|
||||||
# Exclude prerelease tags (matching -rc or -rc.<digits>) from default tag selection
|
# Exclude prerelease tags (matching -rc or -rc.<digits>) from default tag selection
|
||||||
DEFAULT_NEW_TAG="$(git tag --sort=-version:refname | grep --invert-match --perl-regexp "${rc_pattern}" | head --lines 1)"
|
DEFAULT_NEW_TAG="$(git tag --sort=-version:refname | grep --invert-match --perl-regexp "${RC_PATTERN}" | head --lines 1)"
|
||||||
DEFAULT_OLD_TAG="$(git tag --sort=-version:refname | grep --invert-match --perl-regexp "${rc_pattern}" | head --lines 2 | tail --lines 1)"
|
DEFAULT_OLD_TAG="$(git tag --sort=-version:refname | grep --invert-match --perl-regexp "${RC_PATTERN}" | head --lines 2 | tail --lines 1)"
|
||||||
|
|
||||||
if [ -z "${1}" ]; then
|
if [[ -z "${1:-}" ]]; then
|
||||||
read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
|
read -rp "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
|
||||||
if [ -z "${OLD_TAG}" ]; then
|
if [[ -z "${OLD_TAG}" ]]; then
|
||||||
OLD_TAG="${DEFAULT_OLD_TAG}"
|
OLD_TAG="${DEFAULT_OLD_TAG}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
while [ -z "$(git tag --list "${OLD_TAG}")" ]; do
|
while [[ -z "$(git tag --list "${OLD_TAG}")" ]]; do
|
||||||
echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
|
echo "ERROR: Tag '${OLD_TAG}' not found!" >&2
|
||||||
read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
|
read -rp "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
|
||||||
if [ -z "${OLD_TAG}" ]; then
|
if [[ -z "${OLD_TAG}" ]]; then
|
||||||
OLD_TAG="${DEFAULT_OLD_TAG}"
|
OLD_TAG="${DEFAULT_OLD_TAG}"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
else
|
else
|
||||||
OLD_TAG=${1}
|
OLD_TAG="${1}"
|
||||||
if [ -z "$(git tag --list "${OLD_TAG}")" ]; then
|
if [[ -z "$(git tag --list "${OLD_TAG}")" ]]; then
|
||||||
echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
|
echo "ERROR: Tag '${OLD_TAG}' not found!" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ -z "${2}" ]; then
|
if [[ -z "${2:-}" ]]; then
|
||||||
read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
|
read -rp "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
|
||||||
if [ -z "${NEW_TAG}" ]; then
|
if [[ -z "${NEW_TAG}" ]]; then
|
||||||
NEW_TAG="${DEFAULT_NEW_TAG}"
|
NEW_TAG="${DEFAULT_NEW_TAG}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
while [ -z "$(git tag --list "${NEW_TAG}")" ]; do
|
while [[ -z "$(git tag --list "${NEW_TAG}")" ]]; do
|
||||||
echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
|
echo "ERROR: Tag '${NEW_TAG}' not found!" >&2
|
||||||
read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
|
read -rp "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
|
||||||
if [ -z "${NEW_TAG}" ]; then
|
if [[ -z "${NEW_TAG}" ]]; then
|
||||||
NEW_TAG="${DEFAULT_NEW_TAG}"
|
NEW_TAG="${DEFAULT_NEW_TAG}"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
else
|
else
|
||||||
NEW_TAG=${2}
|
NEW_TAG="${2}"
|
||||||
|
|
||||||
if [ -z "$(git tag --list "${NEW_TAG}")" ]; then
|
if [[ -z "$(git tag --list "${NEW_TAG}")" ]]; then
|
||||||
echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
|
echo "ERROR: Tag '${NEW_TAG}' not found!" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Check if NEW_TAG is a prerelease (matches -rc or -rc-<digits> suffix)
|
if [[ "${NEW_TAG}" =~ ${RC_PATTERN} ]]; then
|
||||||
if [[ "${NEW_TAG}" =~ ${rc_pattern} ]]; then
|
|
||||||
echo "INFO: Tag '${NEW_TAG}' is a prerelease, setting prerelease annotation and skipping changelog."
|
echo "INFO: Tag '${NEW_TAG}' is a prerelease, setting prerelease annotation and skipping changelog."
|
||||||
yq --no-colors --inplace ".annotations.\"artifacthub.io/prerelease\" = \"true\" | sort_keys(.)" "${CHART_FILE}"
|
yq --no-colors --inplace ".annotations.\"artifacthub.io/prerelease\" = \"true\" | sort_keys(.)" "${CHART_FILE}"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
CHANGE_LOG_YAML=$(mktemp)
|
CHANGE_LOG_YAML="$(mktemp)"
|
||||||
echo "[]" > "${CHANGE_LOG_YAML}"
|
echo "[]" > "${CHANGE_LOG_YAML}"
|
||||||
|
|
||||||
function map_type_to_kind() {
|
map_type_to_kind() {
|
||||||
case "${1}" in
|
case "${1}" in
|
||||||
feat)
|
feat)
|
||||||
echo "added"
|
echo "added"
|
||||||
@@ -97,9 +109,9 @@ echo "INFO: Generate change log entries from ${OLD_TAG} until ${NEW_TAG}"
|
|||||||
while IFS= read -r line; do
|
while IFS= read -r line; do
|
||||||
if [[ "${line}" =~ ^([a-zA-Z]+)(\([^\)]+\))?\:\ (.+)$ ]]; then
|
if [[ "${line}" =~ ^([a-zA-Z]+)(\([^\)]+\))?\:\ (.+)$ ]]; then
|
||||||
TYPE="${BASH_REMATCH[1]}"
|
TYPE="${BASH_REMATCH[1]}"
|
||||||
KIND=$(map_type_to_kind "${TYPE}")
|
KIND="$(map_type_to_kind "${TYPE}")"
|
||||||
|
|
||||||
if [ "${KIND}" == "skip" ]; then
|
if [[ "${KIND}" == "skip" ]]; then
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -109,16 +121,13 @@ while IFS= read -r line; do
|
|||||||
|
|
||||||
jq --arg kind "${KIND}" --arg description "${DESC}" '. += [ $ARGS.named ]' < "${CHANGE_LOG_YAML}" > "${CHANGE_LOG_YAML}.new"
|
jq --arg kind "${KIND}" --arg description "${DESC}" '. += [ $ARGS.named ]' < "${CHANGE_LOG_YAML}" > "${CHANGE_LOG_YAML}.new"
|
||||||
mv "${CHANGE_LOG_YAML}.new" "${CHANGE_LOG_YAML}"
|
mv "${CHANGE_LOG_YAML}.new" "${CHANGE_LOG_YAML}"
|
||||||
|
|
||||||
fi
|
fi
|
||||||
done <<< "${COMMIT_TITLES}"
|
done <<< "${COMMIT_TITLES}"
|
||||||
|
|
||||||
if [ -s "${CHANGE_LOG_YAML}" ]; then
|
if [[ -s "${CHANGE_LOG_YAML}" ]]; then
|
||||||
yq --inplace --input-format json --output-format yml "${CHANGE_LOG_YAML}"
|
yq --inplace --input-format json --output-format yml "${CHANGE_LOG_YAML}"
|
||||||
yq --no-colors --inplace ".annotations.\"artifacthub.io/changes\" |= loadstr(\"${CHANGE_LOG_YAML}\") | sort_keys(.)" "${CHART_FILE}"
|
yq --no-colors --inplace ".annotations.\"artifacthub.io/changes\" |= loadstr(\"${CHANGE_LOG_YAML}\") | sort_keys(.)" "${CHART_FILE}"
|
||||||
else
|
else
|
||||||
echo "ERROR: Changelog file is empty: ${CHANGE_LOG_YAML}" 1>&2
|
echo "ERROR: Changelog file is empty: ${CHANGE_LOG_YAML}" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
rm "${CHANGE_LOG_YAML}"
|
|
||||||
|
|||||||
Reference in New Issue
Block a user