⚠️ Explicitly define WithCompletion as an Option

[Adirio]

Output of go doc ./pkg/cli:

Current state:

package cli // import "sigs.k8s.io/kubebuilder/v3/pkg/cli"

func WithCompletion(c *cli) error
type CLI interface{ ... }
    func New(opts ...Option) (CLI, error)
type Option func(*cli) error
    func WithCommandName(name string) Option
    func WithDefaultPlugins(projectVersion config.Version, plugins ...plugin.Plugin) Option
    func WithDefaultProjectVersion(version config.Version) Option
    func WithExtraCommands(cmds ...*cobra.Command) Option
    func WithPlugins(plugins ...plugin.Plugin) Option
    func WithVersion(version string) Option

With this PR:

package cli // import "sigs.k8s.io/kubebuilder/v3/pkg/cli"

type CLI interface{ ... }
    func New(opts ...Option) (CLI, error)
type Option func(*cli) error
    func WithCommandName(name string) Option
    func WithCompletion() Option
    func WithDefaultPlugins(projectVersion config.Version, plugins ...plugin.Plugin) Option
    func WithDefaultProjectVersion(version config.Version) Option
    func WithExtraCommands(cmds ...*cobra.Command) Option
    func WithPlugins(plugins ...plugin.Plugin) Option
    func WithVersion(version string) Option

Closes: #2044

[camilamacedo86]

It changes the API. However, it is a bug fix. Could you please change the mojo?

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Adirio, camilamacedo86

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 [Adirio,camilamacedo86]

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

[Adirio]

It changes the API. However, it is a bug fix. Could you please change the mojo?

It is not a bug-fix, it works as it is right now. It just improves the API. Therefore, it is a breaking change but it is not fixing anything.

[camilamacedo86]

It is not a bug-fix, it works as it is right now. It just improves the API. Therefore, it is a breaking change but it is not fixing anything.

My point is that besides it works it should be defined as an Option since is an Option. So, it is a bug in the API definition. However, I am not very strong opinionated here. It shows fine too.

/lgtm