You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "villebro (via GitHub)" <gi...@apache.org> on 2026/07/22 00:01:04 UTC
[PR] feat(helm): generate chart README with helm-docs [superset-kubernetes-operator]
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: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat(helm): generate chart README with helm-docs [superset-kubernetes-operator]
Posted by "younsl (via GitHub)" <gi...@apache.org>.
younsl commented on PR #205:
URL: https://github.com/apache/superset-kubernetes-operator/pull/205#issuecomment-5040441843
`helm-docs` supports an optional type hint in the annotation: `# -- (type) description`. Adding it gives two concrete wins for this chart:
**A. Correct `Type` column for empty/placeholder defaults.** Fields like `image.tag`, `serviceAccount.name`, `metrics.certSecretName` default to `""`, and `nodeSelector`/`affinity` to `{}`. Auto-inference works for scalars but is fragile once a placeholder is meant to hold a structured value. Pinning the type documents intent:
```yaml
serviceAccount:
# -- (string) Name of the ServiceAccount to use. Auto-generated from release name when empty.
name: ""
# -- (object) Annotations to add to the ServiceAccount.
annotations: {}
```
**B. Keep the README table readable for large objects.** Without a hint, `resources`, `healthProbes.*`, `podSecurityContext`, and `securityContext` dump their full multi-line YAML into a single table cell. Pair `(object)` with `@default` to collapse it to a link:
```yaml
# -- (object) Compute resource requests and limits for the manager container.
# @default -- See [values.yaml](./values.yaml)
resources:
limits:
cpu: 500m
memory: 512Mi
requests:
cpu: 10m
memory: 64Mi
```
This renders as a clean `object | See values.yaml` row instead of an inlined YAML blob, which also improves the ArtifactHub display.
If you'd prefer to keep this PR focused, I'm happy to send a follow-up PR that adds the `(type)` hints across the remaining fields once this one lands. Just let me know which you'd rather do.
--
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: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat(helm): generate chart README with helm-docs [superset-kubernetes-operator]
Posted by "villebro (via GitHub)" <gi...@apache.org>.
villebro merged PR #205:
URL: https://github.com/apache/superset-kubernetes-operator/pull/205
--
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: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org