Regenerate Helm chart READMEs from values and comments before release
Uses helm-docs to rebuild Helm chart documentation from Chart.yaml, values.yaml, and inline comments so README files stay aligned with the actual chart. The agent can run this before commit or release, then surface changed tables, missing descriptions, and documentation drift in a review-friendly diff.
npx skills add agentskillexchange/skills --skill regenerate-helm-chart-readmes-from-values-and-comments-before-release
This entry is built around helm-docs, the open source tool in the norwoodj/helm-docs repository that generates markdown documentation from Helm charts. In an agent workflow, the job-to-be-done is very specific: inspect a chart, read its metadata and values, parse inline description comments, regenerate the README or another template-driven markdown file, and return a diff that shows whether chart documentation still matches the shipping configuration surface. That makes the agent useful in repositories where chart values evolve quickly and stale docs create deployment mistakes for other operators.
What this skill actually does
You should invoke this skill when an agent edits values.yaml, changes Chart.yaml, reviews a Helm chart pull request, or prepares a release that should include refreshed operator-facing documentation. It is also a good fit for pre-commit hooks and CI jobs that fail when generated README content is out of date. The agent can call helm-docs, inspect the generated markdown, point out undocumented values, and decide whether the result is ready to commit or needs human clarification on missing comments.
The scope boundary is clear. This is not a generic Helm deployment workflow, cluster operator, or packaging system. It does not install charts, render templates for runtime, or manage releases. Its lane is documentation generation and documentation drift detection for Helm charts. Integration points include pre-commit, CI pipelines, docs review bots, release automation, and agent loops that update chart values, regenerate docs, and stage both code and documentation changes together.