.gitattributes: Mark install/kubernetes/cilium/README.md as generated #24295
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
qmonnet
added
the
release-note/misc
The README.md file inside of the install/kubernetes/cilium/ directory has been generated with helm-docs ever since its introduction in commit 7295879 ("build(helm): Add makefile target to generate helm README.md"), using README.md.gotmpl as a template, and other files such as values.yaml (in turn generated from values.yaml.tmpl). It should not be edited by hand. Pull Requests on GitHub usually display changes on this README.md, but instead we want to focus on the source files from which the changes are generated. Let's mark the file as generated, so that the GitHub interface hides the related diff, and reviewers don't lose time looking at it. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
force-pushed
the
pr/gitattributes-readme
branch
from
3708fb4
to
727f90e
Compare
jrajahalme
approved these changes
Mar 13, 2023
|
This file is not used at all by the CI, it only helps GitHub interface rendering diffs, so we're good to go. |
qmonnet
added
the
ready-to-merge
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.
The
README.mdfile inside of theinstall/kubernetes/cilium/directory has been generated withhelm-docsever since its introduction in commit 7295879, usingREADME.md.gotmplas a template, and other files such asvalues.yaml(in turn generated fromvalues.yaml.tmpl). It should not be edited by hand. Pull Requests on GitHub usually display changes on thisREADME.md, but instead we want to focus on the source files from which the changes are generated. Let's mark the file as generated, so that the GitHub interface hides the related diff, and reviewers don't lose time looking at it.