-
Notifications
You must be signed in to change notification settings - Fork 1.6k
🐛 (CLI, deploy-image/v1alpha1, go/v4) Ensure consistent spacing in marker annotations #3904
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
🐛 (CLI, deploy-image/v1alpha1, go/v4) Ensure consistent spacing in marker annotations #3904
Conversation
9ec10d6 to
652f519
Compare
652f519 to
bc2244e
Compare
|
@camilamacedo86 reviewed, looks good 😄 I would add (so the primary problem was fixed!) If you need help fixing the CI, I can take a look |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
bc2244e to
f36b868
Compare
8836636 to
6e669c6
Compare
| // String implements Stringer | ||
| func (m Marker) String() string { | ||
| return m.comment + prefix + m.value | ||
| return m.comment + " " + prefix + m.value |
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.
See that we are changing the CLI here to ensure a space always
6e669c6 to
8a1abd7
Compare
8a1abd7 to
f591596
Compare
|
#3904 (comment) |
f591596 to
cfaa084
Compare
varshaprasad96
left a comment
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.
/lgtm
/approve
Hey @camilamacedo86 - this looks good! Just curious, looks like the space has been introduced in all the places? Is it necessary because iirc c-t does not parse both the cases ?
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, varshaprasad96 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
I think it might be a convention because the user that raised it out complains about some lints checks that raise issues related to it see: However, my main motivation is make it easier for users. It is hard to know what marker should have space or not so since all places has space lets keep the space. That was my thought. |
cfaa084 to
f727d97
Compare
|
New changes are detected. LGTM label has been removed. |
|
I also checked that controller-runtime either is using space for all marker comments , https://github.com/search?q=repo%3Akubernetes-sigs%2Fcontroller-runtime++%22%2F%2F+%2B%22&type=code so that seems the right way to move forward. |
This commit addresses the inconsistency in marker annotations within the kubebuilder project. Previously, kubebuilder markers did not have a space between
//and+marker, unlike those in controller-tools and other related tools see;This inconsistency was causing confusion for end users.
To resolve this, all kubebuilder markers are now updated to include a space, ensuring uniformity across the project. After merging this commit, you can run
make allto regenerate the markers. If any issues arise, use find/replace to change//+to// +.Motivates by: #3801
c/c @mateusoliveira43