Add DO NOT EDIT warn to bootstrap sync manifests
#2050
Merged
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
stefanprodan
added
area/UX
area/bootstrap
hiddeco
reviewed
Nov 4, 2021
hiddeco
reviewed
Nov 4, 2021
Comment on lines
+27
to
+28
| const GenWarning = "# This manifest was generated by flux bootstrap. DO NOT EDIT." | ||
|
|
There was a problem hiding this comment.
Suggested change
| const GenWarning = "# This manifest was generated by flux bootstrap. DO NOT EDIT." | |
| const GenWarning = `# This manifest was generated by flux bootstrap. DO NOT EDIT. | |
| # For modifications to the Flux configuration, see the "customize Flux manifests" documentation. | |
| # Ref: https://fluxcd.io/docs/installation/#customize-flux-manifests | |
| ` | |
There was a problem hiding this comment.
What about Terraform? this comment ends up everywhere manifestgen is used
There was a problem hiding this comment.
I think we need to have a dedicated page for "Customize Flux manifests" where we address both the CLI and TF bootstrap options. After that we could update this comment and add the link to that page.
There was a problem hiding this comment.
We should record this in a follow-up issue.
hiddeco
approved these changes
Nov 4, 2021
Comment on lines
+27
to
+28
| const GenWarning = "# This manifest was generated by flux bootstrap. DO NOT EDIT." | ||
|
|
There was a problem hiding this comment.
We should record this in a follow-up issue.
Signed-off-by: Stefan Prodan <[email protected]>
stefanprodan
force-pushed
the
do-not-edit-warn
branch
from
b02b0d3 to
04faba9
Compare
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.
Fix: #2049