fix: always quote descriptions in AH changelog

vdemeester · claude · vdemeester · commit a118bd735adb · 2026-06-04T16:23:47.000+02:00
Co-Authored-By: Claude &lt;noreply@anthropic.com&gt;
Signed-off-by: Vincent Demeester &lt;vdemeest@redhat.com&gt;
diff --git a/hack/apply-ah-changes.py b/hack/apply-ah-changes.py
@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+"""Replace artifacthub.io/changes annotation in YAML from stdin, write to stdout.
+
+Usage: cat task.yaml | python3 apply-ah-changes.py changes.txt
+"""
+import re
+import sys
+
+content = sys.stdin.read()
+with open(sys.argv[1]) as f:
+    changes_raw = f.read()
+
+# Ensure all description values are quoted
+lines = []
+for line in changes_raw.strip().split('\n'):
+    m = re.match(r'(\s+description:\s*)(.*)', line)
+    if m:
+        prefix, val = m.group(1), m.group(2)
+        val = val.strip().strip('"').strip("'")
+        lines.append(prefix + '"' + val + '"')
+    else:
+        lines.append(line)
+
+new_changes = '    artifacthub.io/changes: |\n' + '\n'.join(lines)
+content = re.sub(
+    r'    artifacthub\.io/changes: \|\n(      .*\n)*',
+    new_changes.rstrip() + '\n',
+    content,
+)
+sys.stdout.write(content)
diff --git a/hack/release.sh b/hack/release.sh
@@ -154,15 +154,12 @@ Output the two sections separated by the exact string ---SEPARATOR--- on its own
 fi
 
 # Sanitize description for Artifact Hub YAML (strip {}[]&*#?|-<>=!%@ or quote)
+# Sanitize and always quote description for Artifact Hub YAML-in-YAML
+# AH parses the changes |block as YAML, so descriptions must be quoted
 sanitize_desc() {
     local d
     d=$(echo "$1" | sed 's/[{}]//g; s/[][&*#?|<>=!%@`]//g' | sed 's/  */ /g' | sed 's/^ //;s/ $//')
-    # Quote if it contains colons (YAML special char)
-    if echo "$d" | grep -qF ':'; then
-        echo "\"${d}\""
-    else
-        echo "$d"
-    fi
+    echo "\"${d}\""
 }
 
 if [[ "${USE_LLM}" != true ]]; then
@@ -215,20 +212,14 @@ apply_version_bumps() {
 
 # --- Helper: update artifacthub changelog in content (stdin → stdout) ---
 apply_ah_changes() {
-    local normalized
-    normalized=$(echo -e "${AH_CHANGES}" | grep -v '^[[:space:]]*```' | sed -e 's/^[[:space:]]*- kind:/      - kind:/' -e 's/^[[:space:]]*description:/        description:/')
-    python3 -c "
-import re, sys
-content = sys.stdin.read()
-new_changes = '''    artifacthub.io/changes: |
-${normalized}'''
-content = re.sub(
-    r'    artifacthub\.io/changes: \|\n(      .*\n)*',
-    new_changes.rstrip() + '\n',
-    content,
-)
-sys.stdout.write(content)
-"
+    local tmpchanges
+    tmpchanges=$(mktemp)
+    echo -e "${AH_CHANGES}" | grep -v '^[[:space:]]*```' \
+        | sed -e 's/^[[:space:]]*- kind:/      - kind:/' \
+              -e 's/^[[:space:]]*description:/        description:/' \
+        > "${tmpchanges}"
+    python3 "${SCRIPT_DIR}/apply-ah-changes.py" "${tmpchanges}"
+    rm -f "${tmpchanges}"
 }
 
 if [[ "${DRY_RUN}" == true ]]; then
diff --git a/stepaction/git-clone/git-clone.yaml b/stepaction/git-clone/git-clone.yaml
@@ -9,54 +9,58 @@ metadata:
   annotations:
     artifacthub.io/category: integration-delivery
     artifacthub.io/changes: |
+- kind: fixed
+        description: "always quote descriptions in AH changelog"
+      - kind: changed
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: quote descriptions containing colons in changelog
+        description: "quote descriptions containing colons in changelog"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: sanitize special YAML chars in changelog descriptions
+        description: "sanitize special YAML chars in changelog descriptions"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: reset version for v1.6.0 re-release (pyyaml generator)
+        description: "reset version for v1.6.0 re-release (pyyaml generator)"
       - kind: fixed
-        description: quote special characters in artifacthub changelog annotation
+        description: "quote special characters in artifacthub changelog annotation"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: reset version to v1.5.0 for v1.6.0 re-release
+        description: "reset version to v1.5.0 for v1.6.0 re-release"
       - kind: fixed
-        description: rewrite StepAction generator with pyyaml
+        description: "rewrite StepAction generator with pyyaml"
       - kind: changed
-        description: bump version to v1.6.1
+        description: "bump version to v1.6.1"
       - kind: fixed
-        description: release script signing and bundle workflow
+        description: "release script signing and bundle workflow"
       - kind: fixed
-        description: release script version detection and signing
+        description: "release script version detection and signing"
       - kind: fixed
         description: "strip spurious resources: from signed task YAMLs"
       - kind: fixed
         description: "strip spurious resources: from signed task YAML"
       - kind: changed
-        description: set Artifact Hub repository ID for StepAction
+        description: "set Artifact Hub repository ID for StepAction"
       - kind: changed
-        description: add Artifact Hub metadata for StepAction repository
+        description: "add Artifact Hub metadata for StepAction repository"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: release script backtick stripping in changelog normalization
+        description: "release script backtick stripping in changelog normalization"
       - kind: changed
-        description: add task signing to release script
+        description: "add task signing to release script"
       - kind: changed
-        description: add parameters and results tables to StepAction README
+        description: "add parameters and results tables to StepAction README"
       - kind: added
-        description: stepaction tests, bundle publishing, release integration
+        description: "stepaction tests, bundle publishing, release integration"
       - kind: changed
-        description: update READMEs for Artifact Hub and StepAction
+        description: "update READMEs for Artifact Hub and StepAction"
       - kind: added
-        description: add git-clone StepAction, generated from Task
+        description: "add git-clone StepAction, generated from Task"
       - kind: changed
-        description: add task signing public key
+        description: "add task signing public key"
     artifacthub.io/license: Apache-2.0
     artifacthub.io/links: |
       - name: support
diff --git a/task/git-clone/git-clone.yaml b/task/git-clone/git-clone.yaml
@@ -4,54 +4,58 @@ metadata:
   annotations:
     artifacthub.io/category: integration-delivery
     artifacthub.io/changes: |
+- kind: fixed
+        description: "always quote descriptions in AH changelog"
+      - kind: changed
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: quote descriptions containing colons in changelog
+        description: "quote descriptions containing colons in changelog"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: sanitize special YAML chars in changelog descriptions
+        description: "sanitize special YAML chars in changelog descriptions"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: reset version for v1.6.0 re-release (pyyaml generator)
+        description: "reset version for v1.6.0 re-release (pyyaml generator)"
       - kind: fixed
-        description: quote special characters in artifacthub changelog annotation
+        description: "quote special characters in artifacthub changelog annotation"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: reset version to v1.5.0 for v1.6.0 re-release
+        description: "reset version to v1.5.0 for v1.6.0 re-release"
       - kind: fixed
-        description: rewrite StepAction generator with pyyaml
+        description: "rewrite StepAction generator with pyyaml"
       - kind: changed
-        description: bump version to v1.6.1
+        description: "bump version to v1.6.1"
       - kind: fixed
-        description: release script signing and bundle workflow
+        description: "release script signing and bundle workflow"
       - kind: fixed
-        description: release script version detection and signing
+        description: "release script version detection and signing"
       - kind: fixed
         description: "strip spurious resources: from signed task YAMLs"
       - kind: fixed
         description: "strip spurious resources: from signed task YAML"
       - kind: changed
-        description: set Artifact Hub repository ID for StepAction
+        description: "set Artifact Hub repository ID for StepAction"
       - kind: changed
-        description: add Artifact Hub metadata for StepAction repository
+        description: "add Artifact Hub metadata for StepAction repository"
       - kind: changed
-        description: bump version to v1.6.0
+        description: "bump version to v1.6.0"
       - kind: fixed
-        description: release script backtick stripping in changelog normalization
+        description: "release script backtick stripping in changelog normalization"
       - kind: changed
-        description: add task signing to release script
+        description: "add task signing to release script"
       - kind: changed
-        description: add parameters and results tables to StepAction README
+        description: "add parameters and results tables to StepAction README"
       - kind: added
-        description: stepaction tests, bundle publishing, release integration
+        description: "stepaction tests, bundle publishing, release integration"
       - kind: changed
-        description: update READMEs for Artifact Hub and StepAction
+        description: "update READMEs for Artifact Hub and StepAction"
       - kind: added
-        description: add git-clone StepAction, generated from Task
+        description: "add git-clone StepAction, generated from Task"
       - kind: changed
-        description: add task signing public key
+        description: "add task signing public key"
     artifacthub.io/license: Apache-2.0
     artifacthub.io/links: |
       - name: support
@@ -72,7 +76,7 @@ metadata:
     tekton.dev/signature: MEYCIQCm/4td/qSjle4l8U0yihk1ONgg6Mr4suUJj24kLKwOdgIhALTuOKknf7fJObtkUb/6ggEjovHDh3ITCNJwRMGuJuKy
     tekton.dev/tags: git
   labels:
-    app.kubernetes.io/version: 1.6.0
+    app.kubernetes.io/version: "1.6.0"
   name: git-clone
 spec:
   description: |-
