ci(flyte-binary): check chart README is regenerated with helm-docs#7544
Merged
Conversation
Add a Check Helm Docs workflow that runs helm-docs (pinned to v1.8.0) against charts/flyte-binary on PRs touching the chart and fails when the committed README.md differs from generated output. This guards against editing values.yaml/Chart.yaml without regenerating the docs. Also regenerate the currently-stale README so the new check passes: it syncs the values table with values.yaml (flyte-core-components.runs/ dataproxy/secret/actions keys, the flytemanager rename) and drops the no-longer-present AppVersion badge and flyteconnector requirement. Signed-off-by: Kevin Su <pingsutw@apache.org>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a CI guard to ensure the charts/flyte-binary/README.md (generated by helm-docs) stays in sync with the Helm chart, and regenerates the committed README so the new check passes.
Changes:
- Add a new GitHub Actions workflow to run
helm-docson PRs that touchcharts/flyte-binary/**and fail if the generated README differs from what’s committed. - Regenerate
charts/flyte-binary/README.mdto match current chart metadata and values.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
charts/flyte-binary/README.md |
Updates generated helm-docs output to reflect current values.yaml / Chart.yaml. |
.github/workflows/check-helm-docs.yml |
Adds CI workflow to regenerate and diff-check the chart README on relevant PRs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The prebuilt helm-docs release binary bakes in a version string and appends an 'Autogenerated from chart metadata using helm-docs' footer (gated on .HelmDocsVersion). The committed README is generated by a go-installed helm-docs, which leaves the version empty and omits the footer. Install helm-docs the same way in CI so the regenerated README is byte-identical and the check is reproducible. Signed-off-by: Kevin Su <pingsutw@apache.org>
Signed-off-by: Kevin Su <pingsutw@apache.org>
AdilFayyaz
approved these changes
Jun 17, 2026
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.
Tracking issue
Related to keeping
charts/flyte-binary/README.mdin sync with the chart.Why are the changes needed?
charts/flyte-binary/README.mdis generated by helm-docs from the chart'svalues.yamlandChart.yaml, but nothing in CI enforces that it stays current. As a result the committed README had drifted from the chart (staleAppVersionbadge, a removedflyteconnectorrequirement, and a values table missing theflyte-core-components.runs/dataproxy/secret/actionskeys and still showingflytepropellerinstead offlytemanager).What changes were proposed in this pull request?
Check Helm Docsworkflow (.github/workflows/check-helm-docs.yml): on PRs that touchcharts/flyte-binary/**(or the workflow itself), it installs helm-docs (pinned tov1.8.0), runshelm-docs --chart-search-root=charts/flyte-binary, and fails if the regeneratedREADME.mddiffers from what is committed — printing the exact command to fix it.values.yamland drops theAppVersionbadge andRequirementssection that no longer exist inChart.yaml.To regenerate locally:
How was this patch tested?
helm-docs --chart-search-root=charts/flyte-binary(v1.8.0) locally; the committed README now matches generated output (git diff --exit-codeis clean), which is the exact assertion the workflow makes.charts/flyte-binary/**and the workflow file, and uses no untrusted event input inrun:steps.Labels
Check all the applicable boxes