phase 4: README + helm-docs + CI freshness gate#4
Merged
Conversation
- README.md.gotmpl: full README structure (what it shows, skills, quick start incl. OCI install, releasing, ExternalSecrets path, verification table). helm-docs renders the values table inline. - README.md: regenerated. Includes CI badges for the lint and smoke workflows. - lint.yml: add a "helm-docs is up to date" step that runs helm-docs and fails the build if README.md drifts from values.yaml. Catches stale docs on PRs.
- Drop {{ chart.description }} (was duplicating the H1 line and the
hand-written prose right after).
- Releasing snippet uses {{ .Version }} so `git tag` lines track
Chart.yaml on bumps instead of staying at v0.1.0 forever.
- Verification table: rewrite as a bullet list. Markdown table cells
inside a fenced row require escaping `|` as `\|`, but inside an
inline code span GitHub renders `\|` literally — so the rendered
table showed `\|` instead of `|`. The bullet form is cleaner and
copy-paste-safe.
helm-docs run is idempotent after these changes.
3 tasks
NoobCoder1209
added a commit
that referenced
this pull request
Jun 7, 2026
Adds docs/screenshots/ci-passing.png showing the green Actions run for PR #4 (smoke matrix: minimal-values + full-values, both Succeeded; Status: Success). Referenced from README.md.gotmpl just under the workflow badges. Repo metadata done in parallel (out-of-band, not in this commit): - Topics set: helm, helm-chart, kubernetes, gitops, devops, chart-testing, github-actions. - Description synced to the PLAN.md blurb. - Visibility flipped to PUBLIC.
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
1 participant
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.
Summary
README.md.gotmpl+ auto-generatedREADME.mdviahelm-docs. Sections: what it shows, skills, quick start (local + OCI from GHCR), releasing, ExternalSecrets snippet, verification gate table, full values table from helm-docs.lint.ymlgains a "helm-docs is up to date" step that fails CI ifREADME.mddrifts fromvalues.yaml. Prevents stale docs.Test plan
helm-docsproduces no diff on a clean tree.lint.yml(now includes helm-docs gate) + smoke jobs.