Skip to content

docs(helm): sync chart values reference from released chart (DEP-370) - #1244

Merged
pmdroid merged 7 commits into
mainfrom
pascal/dep-370-docs-helm-sync
Oct 15, 2026
Merged

pmdroid merged 7 commits into
mainfrom
pascal/dep-370-docs-helm-sync

Conversation

@pmdroid

@pmdroid pmdroid commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

DEP-370. Companion monorepo PR: ArcadeAI/monorepo branch pascal/dep-370-docs-helm-sync.

  • New sync-helm-chart-docs.yml (repository_dispatch: helm_chart_published plus workflow_dispatch). It pulls the released chart from the public OCI registry, extracts the README's generated values section (from monorepo #5085), writes a versioned helm/values-reference page plus per-version copies, and opens a PR.
  • The Helm page's Configuration section links to the values reference instead of Artifact Hub.

Checked on head 81565aa87, after merging origin/main into the branch (normal merge, no rebase or force-push). Run locally by Forge in /workspace/worktrees/docs-1244.

Behavior How it was proven
Dependencies install from the lockfile Real: pnpm install --frozen-lockfile, exit 0
Lint and format Real: pnpm exec ultracite check, exit 0
Unit tests, including the helm sync tests and the new getChangedFilesSince test Real: pnpm vitest --run, exit 0 (73 files, 894 passed, 2 skipped)
Types Real: pnpm typecheck, exit 0
llms.txt generation now sees a page written earlier in the same job and not yet committed (the Bugbot finding) Unit: the new test in tests/scripts/generate-llmstxt.test.ts builds 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 llmstxt end to end Not run: it needs ANTHROPIC_API_KEY, which is not on the box.
The sync workflow itself (OCI pull, PR creation) Not run: it needs a released chart with a generated values section and repo write access.
Independent review Judged: Codex review of the llms.txt fix, no findings.
Seeded 1.11.2 values reference (_chart/1.11.2/values.md and values-reference/page.mdx) Real: page compiled as MDX with @mdx-js/mdx plus remark-gfm and remark-frontmatter, exit 0; content matches the 1.11.2 README section except two ./values.yaml relative links turned into plain code text; in-page anchors resolve; Codex review, no findings.
getChangedFilesSince when the previous llms.txt SHA is unreachable (Bugbot round 2) Unit: new test in tests/scripts/generate-llmstxt.test.ts expects 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.
  • The values reference page is seeded once by hand from the released chart 1.11.2 README (it is not generated, and the page says so). The first real sync needs a chart released after monorepo #5084 and #5085 merge, because 1.11.2 has no generated section; that sync replaces the page automatically.
  • The chart has no examples/ yet.
  • Confirm that DOCS_TRIGGER_PAT can dispatch any docs workflow.
  • This PR must merge before the monorepo half, monorepo#5506, which dispatches the workflow added here.
  • The previously open llms.txt item (Bugbot r4266513115, pnpm llmstxt diffed against HEAD) is fixed in scripts/generate-llmstxt.ts. The Bugbot thread is still unresolved on GitHub: replying to or resolving it needs Pascal's yes.

Proof @ 81565aa

  • Codex autoreview: Codex default model (forge-sched review), 0 findings at P2+ (0 total)
  • Closeout: not run (closeout CLI not available on the box)
  • CI: 8 passed / 0 failed / 0 pending of 9 (1 skipped)

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-docs GitHub Action runs on repository_dispatch (helm_chart_published) or manual workflow_dispatch: it pulls the chart from public OCI, runs scripts/sync-helm-chart-docs.ts, regenerates public/llms.txt in the same job (because GITHUB_TOKEN PRs do not trigger the existing llmstxt workflow), and opens an auto PR.

scripts/lib/helm-chart-docs.ts extracts the generated values block from the chart README (or values.md), MDX-escapes it, writes _chart/<version>/values.md plus optional examples/, and updates values-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.

getChangedFilesSince in scripts/generate-llmstxt.ts now 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.

@vercel

vercel Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 15, 2026 6:26pm UTC

Request Review

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

Comment thread .github/workflows/sync-helm-chart-docs.yml

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

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

Comment thread scripts/generate-llmstxt.ts
@pmdroid

pmdroid commented Oct 15, 2026

Copy link
Copy Markdown
Member Author

@pmdroid
pmdroid marked this pull request as ready for review October 15, 2026 17:54
@pmdroid
pmdroid merged commit 82b4fa1 into main Oct 15, 2026
10 checks passed

This branch was successfully deployed

1 active deployment
Preview — 81565aa8 Deployed Oct 15, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants