fix(Chart): escape changelog messages for artifacthub

.gitea/scripts/add-annotations.sh

@@ -4,13 +4,12 @@ set -e
 
 CHART_FILE="Chart.yaml"
 if [ ! -f "${CHART_FILE}" ]; then
-  echo "ERROR: ${CHART_FILE} not found!"
+  echo "ERROR: ${CHART_FILE} not found!" 1>&2
   exit 1
 fi
 
-
-DEFAULT_NEW_TAG="$(git describe --abbrev=0)"
-DEFAULT_OLD_TAG="$(git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1 --max-count=1)")"
+DEFAULT_NEW_TAG="$(git tag --sort=-version:refname | head -n 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
@@ -19,7 +18,7 @@ if [ -z "${1}" ]; then
   fi
 
   while [ -z "$(git tag --list "${OLD_TAG}")" ]; do
-    echo "ERROR: Tag '${OLD_TAG}' not found!"
+    echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
     read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
     if [ -z "${OLD_TAG}" ]; then
       OLD_TAG="${DEFAULT_OLD_TAG}"
@@ -28,34 +27,35 @@ if [ -z "${1}" ]; then
 else
   OLD_TAG=${1}
   if [ -z "$(git tag --list "${OLD_TAG}")" ]; then
-    echo "ERROR: Tag '${OLD_TAG}' not found!"
+    echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
     exit 1
   fi
 fi
 
-if [ -z "${1}" ]; then
+if [ -z "${2}" ]; then
   read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
   if [ -z "${NEW_TAG}" ]; then
     NEW_TAG="${DEFAULT_NEW_TAG}"
   fi
 
   while [ -z "$(git tag --list "${NEW_TAG}")" ]; do
-    echo "ERROR: Tag '${NEW_TAG}' not found!"
+    echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
     read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
     if [ -z "${NEW_TAG}" ]; then
       NEW_TAG="${DEFAULT_NEW_TAG}"
     fi
   done
 else
-  NEW_TAG=${1}
+  NEW_TAG=${2}
 
   if [ -z "$(git tag --list "${NEW_TAG}")" ]; then
-    echo "ERROR: Tag '${NEW_TAG}' not found!"
+    echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
     exit 1
   fi
 fi
 
-YAML_FILE=$(mktemp)
+CHANGE_LOG_YAML=$(mktemp)
+echo "[]" > "${CHANGE_LOG_YAML}"
 
 function map_type_to_kind() {
   case "${1}" in
@@ -80,24 +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}"
 
-yq --no-colors --inplace ".annotations.\"artifacthub.io/changes\" |= loadstr(\"${YAML_FILE}\") | sort_keys(.)" "${CHART_FILE}"
-yq --no-colors --inplace ".version = \"${NEW_TAG}\"" "${CHART_FILE}"
+if [ -s "${CHANGE_LOG_YAML}" ]; then
+  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: ${CHANGE_LOG_YAML}" 1>&2
+  exit 1
+fi
 
-rm "${YAML_FILE}"
+rm "${CHANGE_LOG_YAML}"

.gitea/workflows/release.yaml

@@ -14,21 +14,17 @@ jobs:
       - name: Install tooling
         run: |
           apk update
-          apk add git npm yq
+          apk add git npm jq yq
 
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Add Artifacthub.io annotations
         run: |
-          git fetch --unshallow --tags --force
-
-          NEW_TAG="$(git describe --abbrev=0)"
-          OLD_TAG="$(git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1 --max-count=1)")"
-
-          echo "${NEW_TAG}"
-          echo "${OLD_TAG}"
-
-          .gitea/scripts/add-annotations.sh "${NEW_TAG}" "${OLD_TAG}"
+          NEW_TAG="$(git tag --sort=-version:refname | head --lines 1)"
+          OLD_TAG="$(git tag --sort=-version:refname | head --lines 2 | tail --lines 1)"
+          .gitea/scripts/add-annotations.sh "${OLD_TAG}" "${NEW_TAG}"
 
       - name: Package chart
         env:
@@ -55,4 +51,4 @@ jobs:
           # gitea
           helm repo add --username ${REPOSITORY_OWNER} --password ${GITEA_PACKAGE_REGISTRY_TOKEN} gitea ${GITEA_SERVER_URL}/api/packages/${REPOSITORY_OWNER}/helm
           helm cm-push ${REPOSITORY_NAME}-${PACKAGE_VERSION}.tgz gitea
-          helm repo remove gitea
+          helm repo remove gitea

Chart.yaml

@@ -4,21 +4,6 @@ annotations:
       url: https://git.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter
     - name: support
       url: https://git.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter-charts/issues
-  artifacthub.io/changes: |
-    - kind: changed
-      description: use short flags of cut
-    - kind: added
-      description: support Artifacthub annotations
-    - kind: changed
-      description: update volkerraschek/helm docker tag to v3.18.2
-    - kind: changed
-      description: update docker.io/volkerraschek/helm docker tag to v3.18.2
-    - kind: changed
-      description: update dependency volker.raschek/prometheus-fail2ban-exporter-charts to v0.4.0
-    - kind: changed
-      description: update volkerraschek/helm docker tag to v3.18.1
-    - kind: changed
-      description: update docker.io/volkerraschek/helm docker tag to v3.18.1
 apiVersion: v2
 appVersion: "0.1.1"
 description: Prometheus metric exporter for Fail2Ban

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.0
+CHART_VERSION=0.4.16
 helm show values prometheus-exporters/prometheus-fail2ban-exporter --version "${CHART_VERSION}" > values.yaml
 ```