Repository navigation
docs(helm): sync chart values reference from released chart (DEP-370) - #1244
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…elm-sync # Conflicts: # public/llms.txt
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 9fb2457. Configure here.
pmdroid
marked this pull request as ready for review
October 15, 2026 17:54
sdreyer
approved these changes
Oct 15, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

DEP-370. Companion monorepo PR: ArcadeAI/monorepo branch
pascal/dep-370-docs-helm-sync.sync-helm-chart-docs.yml(repository_dispatch: helm_chart_publishedplusworkflow_dispatch). It pulls the released chart from the public OCI registry, extracts the README's generated values section (from monorepo #5085), writes a versionedhelm/values-referencepage plus per-version copies, and opens a PR.Checked on head
81565aa87, after mergingorigin/maininto the branch (normal merge, no rebase or force-push). Run locally by Forge in/workspace/worktrees/docs-1244.pnpm install --frozen-lockfile, exit 0pnpm exec ultracite check, exit 0getChangedFilesSincetestpnpm vitest --run, exit 0 (73 files, 894 passed, 2 skipped)pnpm typecheck, exit 0llms.txtgeneration now sees a page written earlier in the same job and not yet committed (the Bugbot finding)tests/scripts/generate-llmstxt.test.tsbuilds a temp git repo with an uncommitted modified page and an untracked new page and checks both are returned. It fails on the old HEAD-only logic and passes on the new.pnpm llmstxtend to endANTHROPIC_API_KEY, which is not on the box._chart/1.11.2/values.mdandvalues-reference/page.mdx)@mdx-js/mdxplus remark-gfm and remark-frontmatter, exit 0; content matches the 1.11.2 README section except two./values.yamlrelative links turned into plain code text; in-page anchors resolve; Codex review, no findings.getChangedFilesSincewhen the previousllms.txtSHA is unreachable (Bugbot round 2)tests/scripts/generate-llmstxt.test.tsexpects the edited and untracked files to still be returned with a bogus SHA. It fails on the previous implementation and passes now. Codex review, no findings.examples/yet.DOCS_TRIGGER_PATcan dispatch any docs workflow.pnpm llmstxtdiffed against HEAD) is fixed inscripts/generate-llmstxt.ts. The Bugbot thread is still unresolved on GitHub: replying to or resolving it needs Pascal's yes.Proof @ 81565aa
Note
Low Risk
Docs-site and CI automation only; no runtime product behavior. Workflow needs secrets (e.g. ANTHROPIC_API_KEY) and correct dispatch ordering with the monorepo release.
Overview
Adds automated Helm chart values documentation so each released chart version gets an in-repo values reference instead of pointing readers at Artifact Hub.
A new
sync-helm-chart-docsGitHub Action runs onrepository_dispatch(helm_chart_published) or manualworkflow_dispatch: it pulls the chart from public OCI, runsscripts/sync-helm-chart-docs.ts, regeneratespublic/llms.txtin the same job (becauseGITHUB_TOKENPRs do not trigger the existing llmstxt workflow), and opens an auto PR.scripts/lib/helm-chart-docs.tsextracts the generated values block from the chart README (orvalues.md), MDX-escapes it, writes_chart/<version>/values.mdplus optionalexamples/, and updatesvalues-reference/page.mdx. The Helm deploy page now links to/operate/deploy/helm/values-reference. Chart 1.11.2 is seeded manually as the first snapshot until a post–generated-section chart release drives the workflow.getChangedFilesSinceinscripts/generate-llmstxt.tsnow diffs against the working tree and includes untracked files so CI can summarize pages written in the same job before commit; unreachable SHAs fall back gracefully. Vitest coverage was added for helm sync and the llms.txt change detection.Reviewed by Cursor Bugbot for commit 81565aa. Bugbot is set up for automated code reviews on this repo. Configure here.