Apply suggestions from code review

Co-authored-by: Camila Macedo <[email protected]>

Author: vitorfloriano

pkg/cli/alpha/internal/update.go

@@ -11,6 +11,7 @@ import (
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/afero"
+	"sigs.k8s.io/kubebuilder/v4/pkg/config/store"
 	"sigs.k8s.io/kubebuilder/v4/pkg/config/store/yaml"
 	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
 )
@@ -29,12 +30,8 @@ type Update struct {
 // - upgrade: New Kubebuilder version scaffolding
 // - merge: Attempts to merge upgrade changes into current state
 func (opts *Update) Update() error {
-	// Load the PROJECT configuration file to get the current CLI version
-	projectConfigFile := yaml.New(machinery.Filesystem{FS: afero.NewOsFs()})
-	if err := projectConfigFile.LoadFrom(yaml.DefaultPath); err != nil { // TODO: assess if DefaultPath could be renamed to a more self-descriptive name
-		return fmt.Errorf("fail to run command: %w", err)
-	}
 
+	projectConfigFile, _ := opts.loadConfigFile()
 	// Determine which Kubebuilder version to use for the update
 	cliVersion := projectConfigFile.Config().GetCliVersion()
 
@@ -95,6 +92,15 @@ func (opts *Update) Update() error {
 	return nil
 }
 
+// Load the PROJECT configuration file to get the current CLI version
+func (opts *Update) loadConfigFile() (store.Store, error) {
+	projectConfigFile := yaml.New(machinery.Filesystem{FS: afero.NewOsFs()})
+	if err := projectConfigFile.LoadFrom(yaml.DefaultPath); err != nil { // TODO: assess if DefaultPath could be renamed to a more self-descriptive name
+		return projectConfigFile, fmt.Errorf("fail to run command: %w", err)
+	}
+	return projectConfigFile, nil
+}
+
 // downloadKubebuilderBinary downloads the specified version of Kubebuilder binary
 // from GitHub releases and saves it to a temporary directory with executable permissions.
 // Returns the temporary directory path containing the binary.
@@ -195,15 +201,24 @@ func (opts *Update) cleanUpAncestorBranch() error {
 // to create clean scaffolding in the ancestor branch. This uses the downloaded
 // binary with the original PROJECT file to recreate the project's initial state.
 func (opts *Update) runAlphaGenerate(tempDir, version string) error {
-	tempBinaryPath := tempDir + "/kubebuilder"
+
+	// Restore the original PROJECT file from master branch to ensure
+	// we're using the correct project configuration for scaffolding
+	gitCmd := exec.Command("git", "checkout", "master", "--", "PROJECT")
+	if err := gitCmd.Run(); err != nil {
+		return fmt.Errorf("failed to checkout PROJECT from master")
+	}
+	log.Info("Succesfully checked out the PROJECT file from master branch")
 
 	// Temporarily modify PATH to use the downloaded Kubebuilder binary
+	tempBinaryPath := tempDir + "/kubebuilder"
 	originalPath := os.Getenv("PATH")
 	tempEnvPath := tempDir + ":" + originalPath
 
 	if err := os.Setenv("PATH", tempEnvPath); err != nil {
 		return fmt.Errorf("failed to set temporary PATH: %w", err)
 	}
+
 	// Restore original PATH when function completes
 	defer func() {
 		if err := os.Setenv("PATH", originalPath); err != nil {
@@ -219,7 +234,7 @@ func (opts *Update) runAlphaGenerate(tempDir, version string) error {
 
 	// Restore the original PROJECT file from master branch to ensure
 	// we're using the correct project configuration for scaffolding
-	gitCmd := exec.Command("git", "checkout", "master", "--", "PROJECT")
+	gitCmd = exec.Command("git", "checkout", "master", "--", "PROJECT")
 	if err := gitCmd.Run(); err != nil {
 		return fmt.Errorf("failed to checkout PROJECT from master")
 	}

pkg/cli/alpha/update.go

@@ -20,33 +20,30 @@ func NewUpdateCommand() *cobra.Command {
 	updateCmd := &cobra.Command{
 		Use:   "update",
 		Short: "Update a Kubebuilder project to a newer version",
-		Long: `Update a Kubebuilder project to a newer version using a three-way merge strategy.
+		Long: `This command upgrades your Kubebuilder project to the latest scaffold layout using a 3-way merge strategy.
 
-This command helps you upgrade your Kubebuilder project by:
-1. Creating a clean ancestor branch with the old version's scaffolding
-2. Creating a current branch with your project's current state
-3. Creating an upgrade branch with the new version's scaffolding
-4. Attempting to merge the changes automatically
+It performs the following steps:
+  1. Creates an 'ancestor' branch from the version originally used to scaffold the project
+  2. Creates a 'current' branch with your project's current state
+  3. Creates an 'upgrade' branch using the new version's scaffolding
+  4. Attempts a 3-way merge into a 'merge' branch
 
-The process creates several Git branches to help you manage the upgrade:
-- ancestor: Clean scaffolding from the original version
-- current: Your project's current state
-- upgrade: Clean scaffolding from the new version
-- merge: Attempted automatic merge of upgrade into current
+The process uses Git branches:
+  - ancestor: clean scaffold from the original version
+  - current: your existing project state
+  - upgrade: scaffold from the target version
+  - merge: result of the 3-way merge
 
-If conflicts occur during the merge, you'll need to resolve them manually.
+If conflicts occur during the merge, resolve them manually in the 'merge' branch. 
+Once resolved, commit and push it as a pull request. This branch will contain the 
+final upgraded project with the latest Kubebuilder layout and your custom code.
 
 Examples:
   # Update using the version specified in PROJECT file
   kubebuilder alpha update
 
   # Update from a specific version
-  kubebuilder alpha update --from-version v3.0.0
-
-Requirements:
-- Must be run from the root of a Kubebuilder project
-- Git repository must be clean (no uncommitted changes)
-- PROJECT file must exist and contain a valid layout version`,
+  kubebuilder alpha update --from-version v3.0.0`,
 
 		// TODO: Add validation to ensure we're in a Kubebuilder project and Git repo is clean
 		//	PreRunE: func(_ *cobra.Command, _ []string) error {
@@ -62,7 +59,7 @@ Requirements:
 
 	// Flag to override the version specified in the PROJECT file
 	updateCmd.Flags().StringVar(&opts.FromVersion, "from-version", "",
-		"Override the CLI version from PROJECT file. Specify the Kubebuilder version to upgrade from (e.g., 'v3.0.0' or '3.0.0')")
+		"Kubebuilder binary release version to upgrade from (e.g., v3.0.0). Defaults to cliVersion in PROJECT file. Should match the version used to init the project.")
 
 	return updateCmd
 }