⚠️ 🐛 (API) fix deprecate interface to allow bundle plugin has deprecation message

[camilamacedo86]

Description

This PR enforces the deprecated interface to be implemented so that Bundle Plugins can also be deprecated.
If you are using Kubebuilder as lib, then:

• a) Add an empty string for all bundles plugins which are not deprecated:

Example:

	// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v4 with kustomize alpha-v2
	gov4Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 4},
		"", // Here you must pass an empty string. If you inform an string value here then that means this plugin is deprecated and this string will be used to create the notice message
		kustomizecommonv2alpha.Plugin{},
		golangv4.Plugin{},
	)

• b) Ensure that you implement the Deprecate interface in all plugins

func (p Plugin) DeprecationWarning() string {
	return "" // It should be empty. if you inform a value then that means this plugin is deprecated. 
}

Motivation

Fix the interface to allow Bundles to be deprecated. example:

	const deprecateMessageGoV3Bundle = "This version is deprecated." +
		"The `go/v3` cannot scaffold projects using kustomize versions v4x+" +
		" and cannot fully support Kubernetes 1.25+." +
		"It is recommended to upgrade your project to the latest versions available (go/v4)." +
		"Please, check the migration guide to learn how to upgrade your project"

	// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v3
	gov3Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 3},
		deprecateMessageGoV3Bundle,
		kustomizecommonv1.Plugin{},
		golangv3.Plugin{},
	)

IMPORTANT See that consumers can use it to know when they will perform the deprecation to define their own message for their own Bundle Plugins.

[everettraven]

Overall, this looks good to me - just have one question:

[everettraven]

I wonder if converting this to use the options pattern would be better than adding another function parameter? I think that would prevent this function signature getting really long with future changes.

I think this would look something like:

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

and new bundles could be created like:

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

Thoughts?

[camilamacedo86]

@everettraven here we just fixing the method (which breaks the API)
I totally agree with the approach suggested by you and for we are able to do that I tracked the need in: #3307

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, everettraven, 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]

I am moving this one since it has both approvals.