✨ Make the edit command to be a plugin.

[prafull01]

Description of the change
Moved the edit commands to the plugins just like KB init , KB create api and KB create webhook plugins for v3+.
Kept the v2 behavior exactly same.

Motivation for the change
It would be nice to have the edit plugin which can be extending as well. Also, it is in sync with other commands which have their own extendible plugins. Making edit command a plugin gives us feasibility to extend the functionality of edit command same as any other command in kubebuilder. For example: In #1640 RFE whenever we move the project layout from single group to multi group, the api/ folder (created in single group project layout) should be moved to apis/ folder.

Fixes #1639

[k8s-ci-robot]

Hi @prafull01. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[camilamacedo86]

/ok-to-test

[prafull01]

/test pull-kubebuilder-e2e-k8s-1-16-2

[prafull01]

/test pull-kubebuilder-e2e-k8s-1-17-0

[prafull01]

/test pull-kubebuilder-e2e-k8s-1-17-0

[camilamacedo86]

I tested and it worked fine:

$ kubebuilder edit --multigroup
camilamacedo@Camilas-MacBook-Pro ~/go/src/multigroup (test-ocp) $ cat PROJECT 
domain: my.domain
layout: go.kubebuilder.io/v2
multigroup: true
projectName: multigroup
repo: multigroup
version: 3-alpha

Just a few nits otherwise it shows great 👍

[camilamacedo86]

/ok-to-test

[prafull01]

/test pull-kubebuilder-e2e-k8s-1-14-1

[camilamacedo86]

Just for reference. I think the code :

kubebuilder/pkg/plugin/v2/scaffolds/edit.go

Lines 53 to 70 in 8c19293

	// update dockerfile
	if s.multigroup {
	str, err = ensureExistAndReplace(
	str,
	"COPY api/ api/",
	`COPY apis/ apis/`)
	if err != nil {
	return err
	}
	} else {
	str, err = ensureExistAndReplace(
	str,
	"COPY apis/ apis/",
	`COPY api/ api/`)
	if err != nil {
	return err
	}
	}

would better fit in the postscafold plugin action.

However, I do not think that it is a blocker for the PR and it also might change soon. So, it for me is

/approve

Great work 👍

[camilamacedo86]

Hi @prafull01,

Could we just update the title for something such as: make the edit command to be a plugin?

[prafull01]

Hi @prafull01,

Could we just update the title for something such as: make the edit command to be a plugin?
Done

[camilamacedo86]

HI @prafull01,

I update the title for :sparkles: Make the edit command to be a plugin. because it does not change any behaviour. Only move the edit subcommand implementation to be a plugin as we did for creating api and webhooks. So, it is not specific for v3+ our v2+

[Adirio]

I will let others decide if this is required but you should include some motivation why kubebuilder edit should be considered a plugin instead of an extra command. Examples of what you could do with this for example. What I understand from the code is that it does exaclty the same without setting the layout field of the project configuration file.

Aside from that, a couple NITs to keep the comments same as the other interfaces.

[camilamacedo86]

Hi @Adirio,

Thank you for your input.

I will let others decide if this is required but you should include some motivation why kubebuilder edit should be considered a plugin instead of an extra command. Examples of what you could do with this for example. What I understand from the code is that it does exaclty the same without setting the layout field of the project configuration file.

The addon and edit should be plugins because all subcommands of kubebuilder should follow this design introduced in the plugin phase 1 in order to keep a standard and consistency in the project whcih is helpful to keep it maintained. Also, it allows other projects to use this plugin whcih is the purpose of the EP https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-1.md .

PS.: Both issues (#1543, #1639) were tracked by myself after a chat with @DirectXMan12 over it.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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

[camilamacedo86]

It is approved for 2 contributors/reviewers so I think we can move forward with it is as well.
Also, note that it does not change anything for v2+ plugin

/lgtm