Update helm docs#1035
Conversation
|
Claude finished @ci-signed-commit-bot[bot]'s task in 1m 30s —— View job Review: helm docs update
Note: This PR isn't a dependency bump (the review template assumed one) — it's a helm-docs regeneration of SummaryThis is a low-risk, autogenerated docs sync. It reconciles the committed
Plus a trailing newline added at EOF — cosmetic, matches the generator's output. On the default ( On the type ( Recommendation✅ Safe to merge. The change correctly re-syncs generated docs and removes unsustainable hand-edits. If the |
| | reporterConfig.environments | list | `[]` | List of Kosli environments to report to. Each entry has required 'name' and optional namespace selectors. Use one entry to report a single environment; use multiple entries to report to multiple environments with different selectors. Per entry: name (required), namespaces, namespacesRegex, excludeNamespaces, excludeNamespacesRegex (optional). Leave namespace fields unset for an entry to report the entire cluster to that environment. | | ||
| | reporterConfig.httpProxy | string | `""` | the http proxy url | | ||
| | reporterConfig.includeScaling | bool | `null` (server default) | whether to record scaling (replica count) changes for every environment auto-created in this run. Leave unset to use the Kosli server default; set to `true` to pass `--include-scaling` or `false` to pass `--exclude-scaling`. Only used when `autoEnvironment` is true; existing environments are never modified. | | ||
| | reporterConfig.includeScaling | string | `nil` (server default) | whether to record scaling (replica count) changes for every environment auto-created in this run. Leave unset to use the Kosli server default; set to `true` to pass `--include-scaling` or `false` to pass `--exclude-scaling`. Only used when `autoEnvironment` is true; existing environments are never modified. | |
There was a problem hiding this comment.
Type accuracy note (non-blocking). This regeneration changes the documented type from bool → string and the default from `null` → `nil`.
`nil`is correct — it comes straight from the# @default --nil(server default)annotation invalues.yaml(line 73). The previous`null`was a hand-edit that drifted from the annotation.string, however, is less accurate than the previousbool. The field is a nullable boolean (the template gates onkindIs "bool"incronjob.yaml:119). helm-docs infersstringonly because the value isnulland it can't detect the intended type.
Since this README is autogenerated (see the footer), hand-editing it to say bool isn't sustainable — the next regen wipes it (which is exactly what's happening here). If the bool type matters for readers, the durable fix is to make it explicit in the field's # -- description text rather than in the type column. Otherwise this change is fine to accept as-is.
Update helm docs