✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins #4572

sarthaksarthak9 · 2025-02-21T09:52:34Z

Fixed issue where 'kubebuilder alpha generate' failed if PROJECT contained go.kubebuilder.io/v3.
Automatically updates outdated plugin references (v3 → v4) to support scaffolding.
Added a warning to notify users before modifying the PROJECT file.

k8s-ci-robot · 2025-02-21T09:52:42Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sarthaksarthak9
Once this PR has been reviewed and has the lgtm label, please assign camilamacedo86 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

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

k8s-ci-robot · 2025-02-21T09:52:44Z

Hi @sarthaksarthak9. 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-sigs/prow repository.

camilamacedo86 · 2025-02-21T14:07:00Z

pkg/cli/alpha/internal/generate.go

+
+	for i, plugin := range plugins {
+		if plugin == "go.kubebuilder.io/v3" {
+			plugins[i] = "go.kubebuilder.io/v4"


can we add a break here?
WDYT?

If there's a possibility that "go.kubebuilder.io/v3" appears multiple times in plugins, then we should not add a break, as we need to update all occurrences.

No, it can appears just once.
We can either check the layout, see: https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v4/PROJECT#L7

pkg/cli/cmd_helpers.go

camilamacedo86 · 2025-02-21T14:11:41Z

pkg/cli/cmd_helpers.go

+	log.Warnf("Detected 'go.kubebuilder.io/v3' in PROJECT file.")
+	log.Warnf("Kubebuilder v4 no longer supports this. It will be replaced with 'go.kubebuilder.io/v4'.")
+
+	fmt.Print("Do you want to proceed? (y/N): ")


That is very cool 🥇 🚀
When we scaffold the controllers/API (kubebuilder create API) we asked if we should scaffold both controller + API. So, we have some code utils for that already, Could we try to use those? See:

https://github.com/kubernetes-sigs/kubebuilder/blob/master/pkg/plugin/util/stdin.go#L28-L40

kubebuilder/pkg/plugins/golang/v4/api.go

Lines 130 to 139 in 74ef8af

reader := bufio.NewReader(os.Stdin)

if !p.resourceFlag.Changed {

log.Println("Create Resource [y/n]")

p.options.DoAPI = util.YesNo(reader)

}

if !p.controllerFlag.Changed {

log.Println("Create Controller [y/n]")

p.options.DoController = util.YesNo(reader)

}

Also, to allow us to test out this option with scripts, could we create a flag so that we do not need to ask if the flag is set? --allow-best-effort OR we can use --force true OR any other term if you have a better idea/suggestion.

camilamacedo86

Really great job 🥇 🎉
I added some comments, and I think we need to add a test for this case.
Otherwise, it is all amazing !!!

camilamacedo86 · 2025-02-21T14:18:15Z

pkg/cli/cli.go

+	if c.cmd.CalledAs() == "alpha generate" {
+		err := updateProjectFileForAlphaGenerate()
+		if err != nil {
+			return fmt.Errorf("failed to update PROJECT file: %w", err)


We have tests here: https://github.com/kubernetes-sigs/kubebuilder/tree/master/test/e2e/alphagenerate

We can create a new project and add 1 API
Then, update the PROJECT file to replace go.kubebuilder.io/v4 with go.kubebuilder.io/v2 or go.kubebuilder.io/v3 and then call the command with the flag that --force OR allow upgrade the PROJECT file without the need to say Y so we can ensure that works fine.

WDYT?

sarthaksarthak9 · 2025-02-22T17:50:24Z

@camilamacedo86 I noticed that updating the plugin list in getInitArgs() automatically updates the PROJECT file, even though I don’t explicitly see a save function. How is this happening? Could you help me confirm where the file update is triggered?. Also, is there still a need for updateProjectFileForAlphaGenerate() in this case?

camilamacedo86 · 2025-02-24T07:58:09Z

pkg/cli/cmd_helpers.go

+
+	// No need to update if v3 is not found
+	if !strings.Contains(projectStr, "go.kubebuilder.io/v3") {
+		return nil 


You need fix the lint issues.
You can run locally make fix-lint

Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins

6805977

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 21, 2025

k8s-ci-robot requested review from camilamacedo86 and Kavinjsir February 21, 2025 09:52

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 21, 2025

sarthaksarthak9 changed the title ~~(:sparkles:) Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins~~ (:sparkles:): Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins Feb 21, 2025

sarthaksarthak9 changed the title ~~(:sparkles:): Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins~~ (:sparkles:)Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins Feb 21, 2025

sarthaksarthak9 changed the title ~~(:sparkles:)Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins~~ ✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins Feb 21, 2025

camilamacedo86 reviewed Feb 21, 2025

View reviewed changes

pkg/cli/cmd_helpers.go Show resolved Hide resolved

camilamacedo86 reviewed Feb 21, 2025

View reviewed changes

camilamacedo86 requested changes Feb 21, 2025

View reviewed changes

camilamacedo86 reviewed Feb 21, 2025

View reviewed changes

camilamacedo86 reviewed Feb 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins #4572

✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins #4572

sarthaksarthak9 commented Feb 21, 2025 •

edited

Loading

k8s-ci-robot commented Feb 21, 2025

k8s-ci-robot commented Feb 21, 2025

camilamacedo86 Feb 21, 2025

sarthaksarthak9 Feb 21, 2025

camilamacedo86 Feb 21, 2025

camilamacedo86 Feb 21, 2025 •

edited

Loading

camilamacedo86 Feb 21, 2025

camilamacedo86 left a comment •

edited

Loading

camilamacedo86 Feb 21, 2025

sarthaksarthak9 commented Feb 22, 2025 •

edited

Loading

camilamacedo86 Feb 24, 2025

	reader := bufio.NewReader(os.Stdin)
	if !p.resourceFlag.Changed {
	log.Println("Create Resource [y/n]")
	p.options.DoAPI = util.YesNo(reader)
	}
	if !p.controllerFlag.Changed {
	log.Println("Create Controller [y/n]")
	p.options.DoController = util.YesNo(reader)
	}

✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins #4572

Are you sure you want to change the base?

✨ Ensure 'kubebuilder alpha generate' rescaffolds with outdated plugins #4572

Conversation

sarthaksarthak9 commented Feb 21, 2025 • edited Loading

k8s-ci-robot commented Feb 21, 2025

k8s-ci-robot commented Feb 21, 2025

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

sarthaksarthak9 Feb 21, 2025

Choose a reason for hiding this comment

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

camilamacedo86 Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

camilamacedo86 left a comment • edited Loading

Choose a reason for hiding this comment

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

sarthaksarthak9 commented Feb 22, 2025 • edited Loading

camilamacedo86 Feb 24, 2025

Choose a reason for hiding this comment

sarthaksarthak9 commented Feb 21, 2025 •

edited

Loading

camilamacedo86 Feb 21, 2025 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

sarthaksarthak9 commented Feb 22, 2025 •

edited

Loading