docs: run GitHub action when Charts are touched to check Helm values ref #16577
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
PR cilium#16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts. The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates). Fixes: cilium#16238 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
tklauser
approved these changes
Jun 17, 2021
|
I see that #16238 was backported to 1.10. Should we backport this PR as well? |
|
I don't really expect backports to introduce spelling mistakes or mismatches in the spelling list, but seeing how simple the change is (and that the list of files triggering runs for the GH action has been backported too), I guess there's no harm in backporting this one as well. |
pchaigno
approved these changes
Jun 22, 2021
pchaigno
added
the
ready-to-merge
bmcustodio
approved these changes
Jun 22, 2021
maintainer-s-little-helper
bot
moved this from Needs backport from master
to Backport pending to v1.10
in 1.10.2
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.2
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.2
qmonnet
added a commit
to qmonnet/cilium
that referenced
this pull request
Jul 1, 2021
A spurious slash at the end of the pattern for files to watch for changes in the description of the GitHub workflow prevented the action to run on all changes of the Helm values. Fix it. Fixes: 4e5272b ("docs: run GitHub action when Charts are touched to check Helm values ref") Fixes: cilium#16577 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
joestringer
pushed a commit
that referenced
this pull request
Jul 1, 2021
A spurious slash at the end of the pattern for files to watch for changes in the description of the GitHub workflow prevented the action to run on all changes of the Helm values. Fix it. Fixes: 4e5272b ("docs: run GitHub action when Charts are touched to check Helm values ref") Fixes: #16577 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added a commit
to qmonnet/cilium
that referenced
this pull request
Jul 1, 2021
[ upstream commit b89118b ] A spurious slash at the end of the pattern for files to watch for changes in the description of the GitHub workflow prevented the action to run on all changes of the Helm values. Fix it. Fixes: 4e5272b ("docs: run GitHub action when Charts are touched to check Helm values ref") Fixes: cilium#16577 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
aanm
pushed a commit
that referenced
this pull request
Jul 2, 2021
[ upstream commit b89118b ] A spurious slash at the end of the pattern for files to watch for changes in the description of the GitHub workflow prevented the action to run on all changes of the Helm values. Fix it. Fixes: 4e5272b ("docs: run GitHub action when Charts are touched to check Helm values ref") Fixes: #16577 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
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.
PR #16238 added a reference for the Helm values in the Charts to the documentation. A number of these values are not common words from the dictionary, and need to be added to the list of acceptable words in the spelling list as we update the charts.
The GitHub action for documentation is supposed to help with the task, catching omitted keywords. But it is only run when a number of documentation-related files are run, and this does not currently include the Charts! Let's fix in order to catch spelling mistake (or omitted spelling list updates).
Fixes: #16238