Repository navigation
fix(helm-upgrade-doc): wrap generated guides in a hidden Liquid raw block - #948
Conversation
…lock
charts.lerian.studio is built by GitHub Pages (Jekyll 3.10), which runs Liquid
over every .md. Upgrade guides carry Helm template snippets ({{ ... }}): they
raised hundreds of Liquid warnings and an unterminated one broke the whole
site build (LerianStudio/helm#2565 fixes the existing guides).
Generated guides that contain {{ or {% are now wrapped in
<!-- {% raw %} --> ... <!-- {% endraw %} -->: Liquid honours the tags and
GitHub's markdown view hides the comments. Raw markers are stripped from the
few-shot examples and from the model output first, so the model never echoes
them and the wrap is never nested (nested raw breaks Liquid too).
|
Warning Review limit reachedThe included review limit has been reached and this organization has disabled usage-based review continuation. Wait for reviews to reset or ask a billing admin to change After included review limits.
Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing. Next included review available in 7 minutes. View limit details
Comment |
🔍 Lint Analysis
|
🔍 PR Validation Summary✅ PR Mergeable — no blocking failures
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
@coderabbitai review |
|
What
helm-upgrade-docnow writes generated upgrade guides that contain Helm template snippets ({{/{%) wrapped in a Liquid raw block hidden in HTML comments:Raw markers are stripped from the few-shot examples and from the model output before wrapping, so the model never echoes them and the wrap is never nested.
Why
charts.lerian.studio is built by GitHub Pages (Jekyll 3.10), which runs Liquid over every
.md. Upgrade guides carry Helm snippets: they raised hundreds of Liquid warnings, and an unterminated{{in one guide broke the whole site build. LerianStudio/helm#2565 fixes the existing guides; this keeps new ones from re-breaking it.{% raw %}inside an HTML comment; GitHub's markdown view hides the comment, so guides read the same on github.com.Testing
bash -nand shellcheck pass. The guard was exercised on four cases: guide with Helm snippets (wrapped once), model output that copied the markers (stripped, wrapped once), guide without templates (unchanged), example doc with markers (stripped before reaching the prompt).🤖 Generated with Claude Code