fix(Chart): escape changelog messages for artifacthub

.gitea/scripts/add-annotations.sh

@@ -8,8 +8,8 @@ if [ ! -f "${CHART_FILE}" ]; then
   exit 1
 fi
 
-DEFAULT_NEW_TAG="$(git describe --abbrev=0)"
+DEFAULT_NEW_TAG="$(git tag --sort=-version:refname | head -n 1)"
-DEFAULT_OLD_TAG="$(git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1 --max-count=1)")"
+DEFAULT_OLD_TAG="$(git tag --sort=-version:refname | head -n 2 | tail -n 1)"
 
 if [ -z "${1}" ]; then
   read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
@@ -54,7 +54,8 @@ else
   fi
 fi
 
-YAML_FILE=$(mktemp)
+CHANGE_LOG_YAML=$(mktemp)
+echo "[]" > "${CHANGE_LOG_YAML}"
 
 function map_type_to_kind() {
   case "${1}" in
@@ -79,28 +80,35 @@ function map_type_to_kind() {
   esac
 }
 
-COMMIT_TITLES=$(git log "${OLD_TAG}..${NEW_TAG}" --pretty=format:"%s")
+COMMIT_TITLES="$(git log --pretty=format:"%s" "${OLD_TAG}..${NEW_TAG}")"
+
+echo "INFO: Generate change log entries from ${OLD_TAG} until ${NEW_TAG}"
 
 while IFS= read -r line; do
   if [[ "${line}" =~ ^([a-zA-Z]+)(\([^\)]+\))?\:\ (.+)$ ]]; then
     TYPE="${BASH_REMATCH[1]}"
+    KIND=$(map_type_to_kind "${TYPE}")
 
-    if [ "${TYPE}" == "skip" ]; then
+    if [ "${KIND}" == "skip" ]; then
       continue
     fi
 
     DESC="${BASH_REMATCH[3]}"
-    KIND=$(map_type_to_kind "${TYPE}")
 
-    yq --inplace ". += [ {\"kind\": \"${KIND}\", \"description\": \"${DESC}\"}]" "${YAML_FILE}"
+    echo "- ${KIND}: ${DESC}"
+
+    jq --arg kind changed --arg description "$DESC" '. += [ $ARGS.named ]' < ${CHANGE_LOG_YAML} > ${CHANGE_LOG_YAML}.new
+    mv ${CHANGE_LOG_YAML}.new ${CHANGE_LOG_YAML}
+
   fi
 done <<< "${COMMIT_TITLES}"
 
-if [ -s "${YAML_FILE}" ]; then
+if [ -s "${CHANGE_LOG_YAML}" ]; then
-  yq --no-colors --inplace ".annotations.\"artifacthub.io/changes\" |= loadstr(\"${YAML_FILE}\") | sort_keys(.)" "${CHART_FILE}"
+  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}"
 else
-  echo "ERROR: Changelog file is empty: ${YAML_FILE}" 1>&2
+  echo "ERROR: Changelog file is empty: ${CHANGE_LOG_YAML}" 1>&2
   exit 1
 fi
 
-rm "${YAML_FILE}"
+rm "${CHANGE_LOG_YAML}"

.gitea/workflows/release.yaml

@@ -2,8 +2,6 @@ name: Release
 
 on:
   push:
-    branches:
-    - master
     tags:
     - "**"
 
@@ -16,7 +14,7 @@ jobs:
       - name: Install tooling
         run: |
           apk update
-          apk add git npm yq
+          apk add git npm jq yq
 
       - uses: actions/checkout@v4
         with:
@@ -24,11 +22,8 @@ jobs:
 
       - name: Add Artifacthub.io annotations
         run: |
-          git tag
+          NEW_TAG="$(git tag --sort=-version:refname | head --lines 1)"
-
+          OLD_TAG="$(git tag --sort=-version:refname | head --lines 2 | tail --lines 1)"
-          NEW_TAG="$(git describe --abbrev=0)"
-          OLD_TAG="$(git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1 --max-count=1)")"
-
           .gitea/scripts/add-annotations.sh "${OLD_TAG}" "${NEW_TAG}"
 
       - name: Package chart

README.md

@@ -42,7 +42,7 @@ version of the chart must be in sync with the `values.yaml`. Newer *minor* versi
 versions can break something!
 
 ```bash
-CHART_VERSION=0.4.11
+CHART_VERSION=0.4.16
 helm show values prometheus-exporters/prometheus-fail2ban-exporter --version "${CHART_VERSION}" > values.yaml
 ```