Skip to content

Update helm docs - #1047

Merged
mbevc1 merged 1 commit into
mainfrom
helm-docs-update
Jul 28, 2026
Merged

Update helm docs#1047
mbevc1 merged 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 28, 2026

Copy link
Copy Markdown
Contributor

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


PR Review: Update helm docs

  • Gather context (diff, values.yaml, README)
  • Assess change type and correctness
  • Post review

Summary

This PR is a helm-docs autogenerated documentation sync, not a dependency upgrade — no go.mod, go.sum, Chart.yaml, or lockfile changed, and helm-docs itself stays at v1.14.2. The only changed file is charts/k8s-reporter/README.md (+2/-1).

What actually changed:

  1. reporterConfig.includeScaling row — type column string → boolean, and the (boolean) prefix removed from the description text:
    • | reporterConfig.includeScaling | string | ... | (boolean) whether to record... |
    • | reporterConfig.includeScaling | boolean | ... | whether to record... |
  2. A trailing blank line added at end of file.

Correctness check — ✅ consistent with the source

The README is regenerated from values.yaml. The current annotation reads:

# charts/k8s-reporter/values.yaml:72-74
# -- (boolean) whether to record scaling (replica count) changes ...
# @default -- `null` (server default)
includeScaling: null

helm-docs interprets the leading (boolean) as a type override and strips it from the rendered description. So type = boolean + description-without-prefix is exactly the correct output for the current values.yaml. The old string rendering was stale (the value is null, which helm-docs would otherwise infer as string). This regeneration corrects that. The null (server default) default and behavior text are unchanged.

Risk: none. Docs-only, matches the chart source, no functional or dependency impact.

Minor nit (non-blocking): the added trailing blank line at EOF is a cosmetic artifact of the generator; harmless.

No changes needed — this is a clean, correct docs sync.
· helm-docs-update

@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 12:16
@mbevc1
mbevc1 merged commit fa0e426 into main Jul 28, 2026
16 checks passed
@mbevc1
mbevc1 deleted the helm-docs-update branch July 28, 2026 12:21
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.

1 participant