avirajkhare00 opened a new pull request, #3070: URL: https://github.com/apache/iggy/pull/3070
## Summary - Add helm-docs integration to auto-generate Helm chart README from values.yaml comments - Prevents documentation drift between values.yaml and README.md - Removes nginx-specific ingress examples (makes chart controller-neutral) ## Changes - Add `# --` documentation comments to all values in `values.yaml` - Create `README.md.gotmpl` template for helm-docs generation - Add helm-docs installation support to `setup-helm-tools.sh` - Add README drift validation to `test-helm.sh validate` command - Enable helm-docs in CI workflow for validate task ## How it works 1. Values are documented with `# --` comments in `values.yaml` (single source of truth) 2. `helm-docs` generates the README values table from those comments 3. CI validates that README stays in sync with values.yaml ## Test plan - [x] `helm lint --strict` passes - [x] `scripts/ci/test-helm.sh validate` passes - [x] Local kind cluster deployment successful - [x] Server `/ping` endpoint returns `pong` - [x] UI `/healthz` endpoint returns `200` ## AI Usage 1. Tool used: Claude 2. Scope: Implementation of helm-docs integration, CI updates, and testing 3. Verification: Ran helm lint, test-helm.sh validate, and full local kind cluster test 4. Yes, I can explain every line of the change Closes #2985 Made with [Cursor](https://cursor.com) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
