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
What it does
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.
Prerequisites
Helm charts and the helm-docs CLI
Installation
Use the upstream install or setup path that matches your environment:
- brew install norwoodj/tap/helm-docs
- go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
- docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
Requirements and caveats from upstream:
-
Using docker
- and a leaf node within that field, description comments must be added for both
Basic usage or getting-started notes:
-
helm-docs can be installed using homebrew:
-
bash
-
or scoop:
-
Extracted from upstream docs: https://raw.githubusercontent.com/norwoodj/helm-docs/HEAD/README.md
Documentation
Source
Capabilities
Install
Quality
deterministic score 0.45 from registry signals: · indexed on github topic:agent-skills · 8 github stars · SKILL.md body (1,345 chars)