Please describe the feature
As a chart maintainer, I want the chart READMEs to be generated automatically from @param annotations in values.yaml, so that the values table stays in sync with the actual values without manual maintenance, and reviewers don't have to catch missing rows.
Context
Today charts/sda-svc/README.md (and the other chart READMEs) is hand-maintained. The values table drifts out of sync whenever someone adds or changes values — most recently in #2384, where ~30 new global.downloadV2.* rows and global.oidc.jwtSecret were added to values.yaml without corresponding README rows.
All recent values already carry @param/## @param comments (the format read by helm-docs), so the raw material is already there.
Raised during review of #2384 by Copilot and @jbygdell.
Proposed changes
- Add a
README.md.gotmpl template per chart (sda-svc, sda-db, sda-mq, sda-orch) describing the README structure
- Add a GitHub Actions workflow that runs
helm-docs --check on chart changes and fails if README.md is out of sync (or alternatively, regenerates + commits)
- Optionally add a
pre-commit hook so local commits keep READMEs in sync
- Backfill the current divergence (existing
@param gaps between values.yaml and README.md)
Alternatives considered
- Keep hand-maintaining READMEs (current): fragile, drift is inevitable
- Regenerate-and-commit CI: less friction for contributors but commits land in unusual order
helm-docs --check CI: forces contributors to run helm-docs locally but keeps git history clean (recommended)
Acceptance criteria
Additional context
Estimation of size
medium
Estimation of priority
low — cosmetic/maintenance improvement, not blocking functionality.
Please describe the feature
As a chart maintainer, I want the chart READMEs to be generated automatically from
@paramannotations invalues.yaml, so that the values table stays in sync with the actual values without manual maintenance, and reviewers don't have to catch missing rows.Context
Today
charts/sda-svc/README.md(and the other chart READMEs) is hand-maintained. The values table drifts out of sync whenever someone adds or changes values — most recently in #2384, where ~30 newglobal.downloadV2.*rows andglobal.oidc.jwtSecretwere added tovalues.yamlwithout corresponding README rows.All recent values already carry
@param/## @paramcomments (the format read byhelm-docs), so the raw material is already there.Raised during review of #2384 by Copilot and @jbygdell.
Proposed changes
README.md.gotmpltemplate per chart (sda-svc,sda-db,sda-mq,sda-orch) describing the README structurehelm-docs --checkon chart changes and fails ifREADME.mdis out of sync (or alternatively, regenerates + commits)pre-commithook so local commits keep READMEs in sync@paramgaps between values.yaml and README.md)Alternatives considered
helm-docs --checkCI: forces contributors to run helm-docs locally but keeps git history clean (recommended)Acceptance criteria
helm-docsintegrated in CI for all charts undercharts/@paramcoverage audited for each chartREADME.mdis not up to date withvalues.yamlhelm-docslocallyAdditional context
Estimation of size
medium
Estimation of priority
low — cosmetic/maintenance improvement, not blocking functionality.