Skip to content

Update helm docs - #1035

Merged
mbevc1 merged 4 commits into
mainfrom
helm-docs-update
Jul 28, 2026
Merged

Update helm docs#1035
mbevc1 merged 4 commits 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 @mbevc1's task in 39s —— View job


Review: Update helm docs

  • Gather context (diff, commits, prior review threads)
  • Verify prior review feedback was addressed
  • Check regeneration idempotency (trailing whitespace, annotation drift)
  • Post review

Summary

This is a docs-only change to the k8s-reporter Helm chart (autogenerated README.md + its source values.yaml). No Go code is touched, so the Go static-analysis phase (go build / go vet / go mod tidy) is not applicable here.

The latest commits resolve both points from the earlier review rounds:

1. Type accuracy (bool vs string) — resolved the durable way. ✅
The type column still reads string (a helm-docs limitation — it can only infer string from a null value), but the field is now documented as a boolean directly in the description text via the (boolean) prefix in values.yaml:72. That's exactly the sustainable fix suggested earlier: encode the intended type in the # -- description rather than hand-editing the type column, so it survives future regens.

2. Trailing blank line — resolved. ✅
Confirmed the file now ends cleanly right after the autogenerated footer, with no stray trailing blank line:

----------------------------------------------
Autogenerated from chart metadata using helm-docs v1.14.2

3. Idempotency / annotation drift — resolved. ✅
The @default annotation (values.yaml:73) and the rendered README default now both read `null`, so they're consistent and the regeneration is idempotent. The earlier nil/null mismatch between the annotation and the hand-edited README is gone.

Verdict

Clean, minimal, and correctly regenerated with helm-docs v1.14.2 matching CI. All prior feedback addressed. Already approved by @mbevc1 — nothing blocking from me. 👍

Comment thread charts/k8s-reporter/README.md Outdated
@mbevc1
mbevc1 force-pushed the helm-docs-update branch from 492b283 to f748f7e Compare July 28, 2026 11:47
@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 11:57
Comment thread charts/k8s-reporter/README.md Outdated
@mbevc1
mbevc1 disabled auto-merge July 28, 2026 12:08
@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 12:08
@mbevc1
mbevc1 merged commit c7848d8 into main Jul 28, 2026
18 of 19 checks passed
@mbevc1
mbevc1 deleted the helm-docs-update branch July 28, 2026 12:12
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.

2 participants