EPMDEDP-17244: fix: align scaffolded helm chart README with helm-docs - #302
Merged
Conversation
Charts scaffolded with the Envoy Gateway (httproute) exposure failed the helm-docs check on the first build pipeline: the README template listed httproute keys out of alphabetical order and documented gateway.name/namespace as separate rows instead of the single object row helm-docs generates from the values doc comment. Reorder the httproute block before image keys, collapse the gateway rows into one object entry, and keep ingress rows only for non-envoy scaffolds. Signed-off-by: Sergiy Kulanov <sergiy_kulanov@epam.com>
Collaborator
Pipeline
|
| Status | Task | Duration |
|---|---|---|
| ✅ | github-set-pending-status | 6s |
| ✅ | fetch-repository | 9s |
| ✅ | init-values | 7s |
| ✅ | get-cache | 2m8s |
| ✅ | commit-validate | 7s |
| ✅ | dockerfile-lint | 7s |
| ✅ | helm-lint | 7s |
| ✅ | helm-docs | 1m10s |
| ✅ | build | 45s |
| ✅ | sonar | 18s |
| ✅ | save-cache | 8s |
| ✅ | buildkit-build | 18s |
| ✅ | github-report-pipeline-status | 6s |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Charts scaffolded with the Envoy Gateway (httproute) exposure failed the helm-docs check on the first build pipeline: the README template listed httproute keys out of alphabetical order and documented gateway.name/namespace as separate rows instead of the single object row helm-docs generates from the values doc comment. Reorder the httproute block before image keys, collapse the gateway rows into one object entry, and keep ingress rows only for non-envoy scaffolds.