-
Notifications
You must be signed in to change notification settings - Fork 1.6k
🐛 (go/v4): Simplify init directory validation to only block kubebuilder files #5154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+52
−36
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove warnings on dot directories?
As a user, I think I would like to be warn if my GitHub workflow was about to be overridden. Or am I missing something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 🙏 I tried to improve it, but just a heads-up — the warning might show up quite a bit, since
.ideafiles (and others) can cause false positives. We have a ton of those.Please let me know if you spot any important cases that we should actually handle.
Examples:
.github/workflows/ci.yml→.git,.vscode,.idea→ ✅ skipped (no warning).gitignore,go.mod,go.sum→ ✅ ignored (no warning)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's what I was missing ! I forgot that the code doesn't check only for kubebuilder files !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @robinlioret
WDYT?
Could we win your LGTM now to get this one merged?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well. I thinks we should keep the warnings for all the files including the dot files. I feel that skipping them may confuse users.
Imagine the following
If the user doesn't check their git diff, they'll miss the change and could cause issues later on.
This makes sense because nowadays, dot files have very important roles.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.github/workflows/ci.yml seems like the only place where this actually makes
sense. For the other directories, raising a warning doesn’t seem useful and
would just create noise. If we warn on everything, we end up training people
to ignore warnings entirely, which isn’t great practice. It’s better to only
warn when it’s meaningful.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right. The best option would be to add a preparation step that list the files about to be created by kubebuilder and check against this list. Maybe such a list could be statically created at build time?
For the time being, I don't know if it is worth the effort. So the solution in this PR could be a quick win. Let's merge!