You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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. 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update helm docs