Skip to content

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

Merged
guimoreirar merged 2 commits into
developfrom
fix/helm-upgrade-doc-liquid-raw
Oct 20, 2026
Merged

guimoreirar merged 2 commits into
developfrom
fix/helm-upgrade-doc-liquid-raw

Conversation

@guimoreirar

Copy link
Copy Markdown
Member

What

helm-upgrade-doc now writes generated upgrade guides that contain Helm template snippets ({{ / {%) wrapped in a Liquid raw block hidden in HTML comments:

<!-- {% raw %} -->
...guide...
<!-- {% endraw %} -->

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.

  • Liquid honours {% raw %} inside an HTML comment; GitHub's markdown view hides the comment, so guides read the same on github.com.
  • A nested raw is also a Liquid error, hence stripping markers from examples (which will carry the wrap after helm#2565) and from the output first.

Testing

bash -n and 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

…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).
@guimoreirar
guimoreirar requested a review from a team as a code owner October 20, 2026 19:46
@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

The 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.

  • Ask an admin to enable usage-based reviews

Open in CodeRabbit

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.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 95 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: LerianStudio/github-actions-shared-workflows/.coderabbit.yml
  • Review profile: ASSERTIVE
  • Plan: Essentials
  • Run ID: cad48a2d-a078-4393-850c-43ff34f4e9d8
📥 Commits

Reviewing files that changed from the base of the PR and between b29605d and 6e6afa6.

📒 Files selected for processing: 1
  • src/docs/helm-upgrade-doc/scripts/generate-doc.sh
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@lerian-studio

lerian-studio commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🔍 Lint Analysis

Check Files Scanned Status
YAML Lint no changes ⏭️ skipped
Action Lint no changes ⏭️ skipped
Pinned Actions no changes ⏭️ skipped
Markdown Link Check no changes ⏭️ skipped
Spelling Check 1 file(s) ✅ success
Shell Check no changes ⏭️ skipped
README Check no changes ⏭️ skipped
Composite Schema no changes ⏭️ skipped
Deployment Matrix no changes ⏭️ skipped

🔍 View full scan logs

@lerian-studio lerian-studio added size/XS PR changes < 50 lines scripts Changes to shell scripts (src/**/*.sh) labels Oct 20, 2026
@lerian-studio

lerian-studio commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🔍 PR Validation Summary

✅ PR Mergeable — no blocking failures

Check Status Blocking
Source Branch ✅ success yes
PR Title ✅ success yes
PR Description ✅ success yes
Breaking Change Guard ✅ success yes
Commit Signatures ✅ success yes
PR Size ✅ success no
Auto Labels ✅ success no
PR Metadata ✅ success no

🔍 View workflow run

@lerian-studio

This comment has been minimized.

@lerian-studio lerian-studio added the review-ready Required checks passed — CodeRabbit is cleared to review label Oct 20, 2026
@coderabbitai

This comment has been minimized.

@lerian-studio

Copy link
Copy Markdown
Contributor

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@guimoreirar
guimoreirar merged commit a5134a6 into develop Oct 20, 2026
43 of 44 checks passed
@github-actions
github-actions Bot deleted the fix/helm-upgrade-doc-liquid-raw branch October 20, 2026 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-ready Required checks passed — CodeRabbit is cleared to review scripts Changes to shell scripts (src/**/*.sh) size/XS PR changes < 50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants