Skip to content

fix(helm-upgrade-doc): wrap generated guides in a hidden Liquid raw block #948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guimoreirar merged 2 commits into from
Oct 20, 2026
Merged

fix(helm-upgrade-doc): wrap generated guides in a hidden Liquid raw block #948

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bc7419
fix(helm-upgrade-doc): wrap generated guides in a hidden Liquid raw b…
guimoreirar Oct 20, 2026
6e6afa6
Merge branch 'develop' into fix/helm-upgrade-doc-liquid-raw
guimoreirar Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/docs/helm-upgrade-doc/scripts/generate-doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,24 @@ CHART_DIFF=$(git diff "${PREV_TAG}".."${CURRENT_TAG}" -- "${CHART_PATH}/Chart.ya
VALUES_DIFF=$(git diff "${PREV_TAG}".."${CURRENT_TAG}" -- "${CHART_PATH}/values.yaml" 2>/dev/null | head -400 || true)
TEMPLATE_DIFF=$(git diff "${PREV_TAG}".."${CURRENT_TAG}" -- "${CHART_PATH}/templates/" 2>/dev/null | head -300 || true)

# Liquid guard: charts.lerian.studio is built by GitHub Pages (Jekyll 3.10), which runs
# Liquid over every .md, so Helm template snippets ({{ ... }}) in a guide warn or, when
# malformed, break the whole site build. Generated guides are wrapped in a raw block
# hidden in HTML comments (Liquid honours it, GitHub's markdown view hides it). Markers
# are stripped from examples and model output first: a nested raw breaks Liquid too.
strip_liquid_raw() {
{ grep -vE '^[[:space:]]*<!--[[:space:]]*\{%-?[[:space:]]*(end)?raw[[:space:]]*-?%\}[[:space:]]*-->[[:space:]]*$' || true; } \
| sed -E 's/\{%-?[[:space:]]*(end)?raw[[:space:]]*-?%\}//g'
}

# Load 2 most recent existing UPGRADE docs as few-shot examples
EXAMPLES=""
if [ -d "$DOCS_PATH" ]; then
# shellcheck disable=SC2012
while IFS= read -r doc_file; do
DOC_NAME=$(basename "$doc_file")
DOC_CONTENT=$(cat "$doc_file")
# Drop the Liquid raw markers (see "Liquid guard" above) so the model never copies them.
DOC_CONTENT=$(strip_liquid_raw < "$doc_file")
EXAMPLES="$(printf '%s\n=== %s ===\n%s\n' "$EXAMPLES" "$DOC_NAME" "$DOC_CONTENT")"
done < <(ls -t "${DOCS_PATH}"/UPGRADE-*.md 2>/dev/null | head -2)
fi
Expand Down Expand Up @@ -168,6 +179,11 @@ if echo "$FIRST_LINE" | grep -q '^```'; then
CONTENT=$(echo "$CONTENT" | sed '1d; $d')
fi

CONTENT=$(printf '%s\n' "$CONTENT" | strip_liquid_raw)
if printf '%s' "$CONTENT" | grep -qE '\{\{|\{%'; then
CONTENT=$(printf '<!-- {%% raw %%} -->\n%s\n<!-- {%% endraw %%} -->' "$CONTENT")
fi

mkdir -p "$DOCS_PATH"
printf '%s\n' "$CONTENT" > "$DOC_FILE"

Expand Down
Loading