Consider only the last group of comments starting with '# --'. #99
Conversation
This file contains 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
bmcustodio
force-pushed
the
bmcustodio-fix-comments
branch
from
18a7e05
to
797a472
Compare
Signed-off-by: Bruno Miguel Custódio <[email protected]>
bmcustodio
force-pushed
the
bmcustodio-fix-comments
branch
from
797a472
to
8abd6f4
Compare
Signed-off-by: Bruno Miguel Custódio <[email protected]>
bmcustodio
force-pushed
the
bmcustodio-fix-comments
branch
from
13db10f
to
5ddabba
Compare
errordeveloper
pushed a commit
to cilium/cilium
that referenced
this pull request
Jun 25, 2021
'helm-docs' has a bug which causes it to include comments belonging to previously-appearing but commented-out fields. A fix has been proposed in norwoodj/helm-docs#99, but hasn't been reviewed yet. While said PR doesn't get merged it's preferable to switch to a fork containing the fix so we can have a proper description for our Helm chart fields. Signed-off-by: Bruno Miguel Custódio <[email protected]>
errordeveloper
pushed a commit
to cilium/cilium
that referenced
this pull request
Jun 25, 2021
'helm-docs' has a bug which causes it to include comments belonging to previously-appearing but commented-out fields. A fix has been proposed in norwoodj/helm-docs#99, but hasn't been reviewed yet. While said PR doesn't get merged it's preferable to switch to a fork containing the fix so we can have a proper description for our Helm chart fields. [ upstream commit 8d4f1ea ] Signed-off-by: Bruno Miguel Custódio <[email protected]>
errordeveloper
pushed a commit
to cilium/cilium
that referenced
this pull request
Jun 25, 2021
'helm-docs' has a bug which causes it to include comments belonging to previously-appearing but commented-out fields. A fix has been proposed in norwoodj/helm-docs#99, but hasn't been reviewed yet. While said PR doesn't get merged it's preferable to switch to a fork containing the fix so we can have a proper description for our Helm chart fields. [ upstream commit 8d4f1ea ] Signed-off-by: Bruno Miguel Custódio <[email protected]>
|
@norwoodj do you have any plans for merging this in the near future? |
|
@skang0601 Did you get a chance to look into this? It fixes a bug we're hitting at cilium/cilium. |
2 tasks
Merged
6 tasks
vincentmli
added a commit
to vincentmli/cilium
that referenced
this pull request
Sep 21, 2022
…ence helm options that are commented out in install/kubernetes/cilium/values.yaml.tmpl are missing documentation in Documentation/helm-values.rst and in helm reference this is reported in a few GH issues, for example: cilium#21107 This appears to be known helm-doc bug and the bug has not been resolved, a related PR norwoodj/helm-docs#99 that seems has not completely resloved the issue. before the helm-doc bug is root caused, uncomment these helm options as workaround. Since Documentation/helm-values.rst install/kubernetes/cilium/README.md are auto generated, it is difficult to avoid rebase/squash conflicts in local branch and upstream master branch, so introduce the helm option in smaller changes so it easy to review and rebase/squash and merge. Fixes: cilium#21334 cilium#21107 Signed-off-by: Vincent Li <[email protected]>
pchaigno
pushed a commit
to cilium/cilium
that referenced
this pull request
Sep 21, 2022
…ence helm options that are commented out in install/kubernetes/cilium/values.yaml.tmpl are missing documentation in Documentation/helm-values.rst and in helm reference this is reported in a few GH issues, for example: #21107 This appears to be known helm-doc bug and the bug has not been resolved, a related PR norwoodj/helm-docs#99 that seems has not completely resloved the issue. before the helm-doc bug is root caused, uncomment these helm options as workaround. Since Documentation/helm-values.rst install/kubernetes/cilium/README.md are auto generated, it is difficult to avoid rebase/squash conflicts in local branch and upstream master branch, so introduce the helm option in smaller changes so it easy to review and rebase/squash and merge. Fixes: #21334 #21107 Signed-off-by: Vincent Li <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Attempts to fix #96. It seems to work for a complex chart I tested with on which the same issue was being observed. I've also added a couple tests.