Skip to content

Update helm docs#1035

Open
ci-signed-commit-bot[bot] wants to merge 1 commit into
mainfrom
helm-docs-update
Open

Update helm docs#1035
ci-signed-commit-bot[bot] wants to merge 1 commit into
mainfrom
helm-docs-update

Conversation

@ci-signed-commit-bot

Copy link
Copy Markdown
Contributor

Update helm docs

@claude

claude Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @ci-signed-commit-bot[bot]'s task in 1m 30s —— View job


Review: helm docs update

  • Analyze the diff
  • Verify against chart source (values.yaml, templates)
  • Post review

Note: This PR isn't a dependency bump (the review template assumed one) — it's a helm-docs regeneration of charts/k8s-reporter/README.md. I reviewed it as such.

Summary

This is a low-risk, autogenerated docs sync. It reconciles the committed README.md back to what helm-docs v1.14.2 actually produces from the current values.yaml. Two content changes, both faithful to the chart source:

Column Before After Verdict
includeScaling type bool string ⚠️ less accurate — see below
includeScaling default `null` `nil` ✅ correct

Plus a trailing newline added at EOF — cosmetic, matches the generator's output.

On the default (nil): correct. It's pulled directly from the # @default -- nil (server default) annotation in values.yaml:73. The old `null` was a hand-edit that had drifted from the annotation.

On the type (string): technically a regression in readability. The field is a nullable boolean — the template gates on kindIs "bool" (charts/k8s-reporter/templates/cronjob.yaml:119). helm-docs falls back to string only because the value is null and it can't infer the intended type. The previous bool was more informative, but it was a hand-edit of an autogenerated file, so it was doomed to be overwritten (which is what's happening now).

Recommendation

Safe to merge. The change correctly re-syncs generated docs and removes unsustainable hand-edits. If the bool type is important for readers, the durable fix is to state it in the field's # -- description rather than the type column — but that's optional and out of scope for this sync. Left an inline note on the changed line.
helm-docs-update

| 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. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type accuracy note (non-blocking). This regeneration changes the documented type from boolstring and the default from `null``nil`.

  • `nil` is correct — it comes straight from the # @default -- nil (server default) annotation in values.yaml (line 73). The previous `null` was a hand-edit that drifted from the annotation.
  • string, however, is less accurate than the previous bool. The field is a nullable boolean (the template gates on kindIs "bool" in cronjob.yaml:119). helm-docs infers string only because the value is null and 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants