🐛 (CLI, deploy-image/v1alpha1, go/v4) Ensure consistent spacing in marker annotations

[camilamacedo86]

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;

• controller-tools: https://github.com/search?q=repo%3Akubernetes-sigs%2Fcontroller-tools+%22%2F%2F+%2B%22&type=code.
• controller-runtime: https://github.com/search?q=repo%3Akubernetes-sigs%2Fcontroller-runtime++%22%2F%2F+%2B%22&type=code

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 all to regenerate the markers. If any issues arise, use find/replace to change //+ to // +.

Motivates by: #3801

c/c @mateusoliveira43

[mateusoliveira43]

@camilamacedo86 reviewed, looks good 😄

I would add comment-spacings in linters-settings.revive.rules of .golangci.yml to enforce this in the future. Adding it in top of this PR gets only this 2 errors

pkg/rescaffold/migrate.go:333:2: comment-spacings: no space between comment delimiter and comment text (revive)
	//Copy all the contents to the desitination file
	^
pkg/cli/alpha.go:38:3: comment-spacings: no space between comment delimiter and comment text (revive)
		//TODO: If we need to create alpha commands please add a new file for each command
		^

(so the primary problem was fixed!)

If you need help fixing the CI, I can take a look

[camilamacedo86]

See that we are changing the CLI here to ensure a space always

[camilamacedo86]

Hi @mateusoliveira43

#3904 (comment)
That we can do in a follow up after this one get merged.

[varshaprasad96]

/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 ?

[k8s-ci-robot]

[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

Needs approval from an approver in each of these files:

• OWNERS [camilamacedo86,varshaprasad96]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[camilamacedo86]

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 ?

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:

cmd/main.go:52:2: comment-spacings: no space between comment delimiter and comment text (revive)
	//+kubebuilder:scaffold:scheme
	^

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.

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[camilamacedo86]

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.