✨Change NewBundle method to build bundles through working with options

[NikhilSharmaWe]

Description

This PR changes the NewBundle method to work with options. The pattern will like:

func NewBundle(opts ...BundleOptions) (Bundle, error)

and new bundles will be created like:

bundle, err := NewBundle(
  WithName("name"),
  WithVersion(plugin.Version{Number: 4}),
  WithPlugins(plugins ...Plugin),
  WithDeprecationMessage("Deprecated!"),
)

Motivation

Fixes: #3307

[em-r]

might be worth moving all the logic related to supportedProjectVersions as well as allPlugins down below to the WithPlugins function, it will keep the bundle setup handled completely by the BundleOption funcs, and this way, NewBundle will only need to loop through opts and pass a ref of bundle to them.
Example:

func NewBundle(opts ...BundleOption) (Bundle, error) {
   var b bundle

   for _, opt := range opts {
        if err := opt(&b); err != nil {
             return nil, err
        }
   }

  return b, nil
}

[NikhilSharmaWe]

Yes, that is nice for simplicity. But in NewBundle func we also need to return an error when len(supportedProjectVersions) == 0. But we also do not handle the error returned when we use NewBundle, like here. So I think we can ignore returning an error in the func, if we want to implement this since we are not handling the error anyway. Not sure.

Let's see what others think about this.

[em-r]

I think this can be skipped since no deprecation message needs to show up when using go/v4

[camilamacedo86]

@everettraven could you please give a hand on the review of this one?

[camilamacedo86]

Hi @NikhilSharmaWe,

I loved the implementation. However, it is a breaking change in the API could we keep the current func implemented and deprecated it and then just add the new one using the Options? So that we do not affect those that are consuming Kubebuilder as a LIB?

[camilamacedo86]

Can we live it as it is and add a new test for a new function using the Options?

[camilamacedo86]

Could we keep here the old func as it is and add a new func using the Options so that we do not introduce a breaking change? See that the PR is fafling in the API diff check.

[NikhilSharmaWe]

Should revert the changes in the docs too, right?

[camilamacedo86]

@NikhilSharmaWe ,\

The changes in Kubebuilder CLI can still.
I mean, we can use the method here.
We need to have the old one available for those that import and use Kubebuilder as a LIB.

Also, please ensure that you rebase with master branch and it is passing in the tests for we get the PR merged.

[camilamacedo86]

/lgtm
/approved

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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]

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