villebro opened a new pull request, #205: URL: https://github.com/apache/superset-kubernetes-operator/pull/205
## Summary Adds [helm-docs](https://github.com/norwoodj/helm-docs) to the codegen pipeline, generating `charts/superset-operator/README.md` from `# --` annotations in `values.yaml`. The README is regenerated as part of `make codegen` and verified by CI's existing codegen diff check, so it can never silently go stale. Also enriches `values.schema.json` with `description` fields linking Kubernetes-typed values (`resources`, `affinity`, `tolerations`, `podSecurityContext`, `securityContext`, the health probes) to their `corev1` types on pkg.go.dev. This improves both the generated README and ArtifactHub display without changing validation semantics — Helm resolves schemas offline so external `$ref` URLs don't work; descriptive links are the right approach. ## Details - `make helm-docs` downloads and runs helm-docs; `make codegen` includes it - `charts/superset-operator/README.md.gotmpl` controls the README structure - K8s-typed schema fields remain open objects (`additionalProperties` not set); only `description` is added - `docs/contributing/development-setup.md` gains a "Helm chart README" section alongside the existing "API Reference" entry; the make-commands table auto-updated via `make make-commands` -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
