add --force flag to alpha update command

This commit adds the --force flag to the alpha update command.
It also adds e2e tests and documentation for the flag.
The --force flag makes it possible to run the alpha update command in CI workflows.

Author: vitorfloriano

docs/book/src/reference/commands/alpha_update.md

@@ -61,6 +61,12 @@ kubebuilder alpha update \
   --from-branch=main
 ```
 
+Force update even with merge conflicts:
+
+```sh
+kubebuilder alpha update --force
+```
+
 <aside class="note warning">
 <h1>You might need to upgrade your project first</h1>
 
@@ -81,8 +87,46 @@ Once updated, you can use `kubebuilder alpha update` for future upgrades.
 | `--from-version`    | **Required for projects initialized with versions earlier than v4.6.0.** Kubebuilder version your project was created with. If unset, uses the `PROJECT` file. |
 | `--to-version`      | Version to upgrade to. Defaults to the latest version.                                                                                                         |
 | `--from-branch`     | Git branch that contains your current project code. Defaults to `main`.                                                                                        |
+| `--force`           | Force the update even if conflicts occur. Conflicted files will include conflict markers, and a commit will be created automatically. Ideal for automation (e.g., cronjobs, CI).                                                                       |
 | `-h, --help`        | Show help for this command.                                                                                                                                    |
 
+## Using the `--force` flag
+
+When using the `--force` flag, merge conflicts will be committed with conflict markers in the `tmp-kb-update-merge` branch. 
+You should carefully review and resolve these conflicts before merging into your main branch.
+
+After resolving conflicts, run the following command to ensure manifests and generated files are up to date:
+```sh
+make manifests generate fmt vet lint-fix
+```
+
+You might want to run `make all`, ensure that all tests are passing, and thoroughly validate the final result before committing and pushing a pull request to update your project from the `tmp-kb-update-merge` branch.
+
+## Handling Merge Conflicts
+
+If conflicts occur during a merge, Git will stop the process and leave the merge branch in a conflicted state for manual resolution.
+
+To proceed with the merge despite conflicts, you can use the `--force` option. This is useful in automated environments, such as CI pipelines or cron jobs, where you want to create a pull request with the changes - even if conflicts are present.
+
+```
+kubebuilder alpha update --force
+```
+The resulting commit will include conflict markers in the affected files:
+
+```
+<<<<<<< HEAD
+Your changes
+=======
+Incoming changes
+>>>>>>> branch-name
+```
+
+The commit message will indicate that conflicts are present and need to be resolved manually.
+
+<aside>
+Note: This approach is typically used in automation workflows where conflict markers are later addressed by a human, or where preserving the conflicting changes is acceptable for follow-up processing.
+</aside>
+
 <aside class="note warning">
 <h1>Projects generated with </h1>
 

pkg/cli/alpha/internal/update/update.go

@@ -38,6 +38,8 @@ type Update struct {
 	ToVersion string
 	// FromBranch stores the branch to update from, e.g., "main".
 	FromBranch string
+	// Force commits the update changes even with merge conflicts
+	Force bool
 
 	// UpdateBranches
 	AncestorBranch string
@@ -334,8 +336,15 @@ func (opts *Update) mergeOriginalToUpgrade() error {
 		var exitErr *exec.ExitError
 		// If the merge has an error that is not a conflict, return an error 2
 		if errors.As(err, &exitErr) && exitErr.ExitCode() == 1 {
-			log.Warn("Merge completed with conflicts. Manual resolution required.")
 			hasConflicts = true
+			if !opts.Force {
+				log.Warn("Merge stopped due to conflicts. Manual resolution is required.")
+				log.Warn("After resolving the conflicts, run the following command:")
+				log.Warn("    make manifests generate fmt vet lint-fix")
+				log.Warn("This ensures manifests and generated files are up to date, and the project layout remains consistent.")
+				return fmt.Errorf("merge stopped due to conflicts")
+			}
+			log.Warn("Merge completed with conflicts. Conflict markers will be committed.")
 		} else {
 			return fmt.Errorf("merge failed unexpectedly: %w", err)
 		}

pkg/cli/alpha/update.go

@@ -49,9 +49,8 @@ The process uses Git branches:
   - upgrade: scaffold from the target version
   - merge: result of the 3-way merge
 
-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.
+If conflicts occur during the merge, the command will stop and leave the merge branch for manual resolution.
+Use --force to commit conflicts with markers instead. 
 
 Examples:
   # Update from the version specified in the PROJECT file to the latest release
@@ -63,6 +62,9 @@ Examples:
   # Update from a specific version to an specific release
   kubebuilder alpha update --from-version v4.5.0 --to-version v4.7.0	
 
+  # Force update even with merge conflicts (commit conflict markers)
+  kubebuilder alpha update --force
+
 `,
 
 		PreRunE: func(_ *cobra.Command, _ []string) error {
@@ -92,5 +94,9 @@ Examples:
 	updateCmd.Flags().StringVar(&opts.FromBranch, "from-branch", "",
 		"Git branch to use as current state of the project for the update.")
 
+	updateCmd.Flags().BoolVar(&opts.Force, "force", false,
+		"Force the update even if conflicts occur. Conflicted files will include conflict markers, and a "+
+			"commit will be created automatically. Ideal for automation (e.g., cronjobs, CI).")
+
 	return updateCmd
 }

test/e2e/alphaupdate/update_test.go

@@ -32,12 +32,9 @@ import (
 )
 
 const (
-	fromVersion = "v4.5.2"
-	toVersion   = "v4.6.0"
-
-	// Binary patterns for cleanup
-	binFromVersionPattern = "/tmp/kubebuilder" + fromVersion + "-*"
-	binToVersionPattern   = "/tmp/kubebuilder" + toVersion + "-*"
+	fromVersionWithoutConflicts = "v4.5.2"
+	fromVersionWithConflicts    = "v4.5.0"
+	toVersion                   = "v4.6.0"
 )
 
 var _ = Describe("kubebuilder", func() {
@@ -59,8 +56,8 @@ var _ = Describe("kubebuilder", func() {
 			mockProjectDir, err = os.MkdirTemp("/tmp", "kubebuilder-mock-project-")
 			Expect(err).NotTo(HaveOccurred())
 
-			By("downloading kubebuilder v4.5.2 binary to isolated /tmp directory")
-			binFromVersionPath, err = downloadKubebuilder()
+			By("downloading kubebuilder binary to isolated /tmp directory")
+			binFromVersionPath, err = downloadKubebuilderVersion(fromVersionWithoutConflicts)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
@@ -72,8 +69,9 @@ var _ = Describe("kubebuilder", func() {
 
 			// Clean up kubebuilder alpha update downloaded binaries
 			binaryPatterns := []string{
-				binFromVersionPattern,
-				binToVersionPattern,
+				"/tmp/kubebuilder" + fromVersionWithoutConflicts + "-*",
+				"/tmp/kubebuilder" + fromVersionWithConflicts + "-*",
+				"/tmp/kubebuilder" + toVersion + "-*",
 			}
 
 			for _, pattern := range binaryPatterns {
@@ -90,7 +88,7 @@ var _ = Describe("kubebuilder", func() {
 		})
 
 		It("should update project from v4.5.2 to v4.6.0 preserving custom code", func() {
-			By("creating mock project with kubebuilder v4.5.2")
+			By("creating mock project with kubebuilder " + fromVersionWithoutConflicts)
 			createMockProject(mockProjectDir, binFromVersionPath)
 
 			By("injecting custom code in API and controller")
@@ -99,38 +97,87 @@ var _ = Describe("kubebuilder", func() {
 			By("initializing git repository and committing mock project")
 			initializeGitRepo(mockProjectDir)
 
-			By("running alpha update from v4.5.2 to v4.6.0")
+			By("running alpha update from " + fromVersionWithoutConflicts + " to " + toVersion)
 			runAlphaUpdate(mockProjectDir, kbc)
 
 			By("validating custom code preservation")
 			validateCustomCodePreservation(mockProjectDir)
 		})
+
+		It("should stop on merge conflicts when --force is not used", func() {
+			// Download the conflicts version binary for this test
+			conflictsBinPath, err := downloadKubebuilderVersion(fromVersionWithConflicts)
+			Expect(err).NotTo(HaveOccurred())
+			defer func() { _ = os.RemoveAll(filepath.Dir(conflictsBinPath)) }()
+
+			By("creating mock project with kubebuilder " + fromVersionWithConflicts)
+			createMockProject(mockProjectDir, conflictsBinPath)
+
+			By("initializing git repository and committing mock project")
+			initializeGitRepo(mockProjectDir)
+
+			By("running alpha update without --force flag")
+			cmd := exec.Command(kbc.BinaryName, "alpha", "update",
+				"--from-version", fromVersionWithConflicts, "--to-version", toVersion, "--from-branch", "main")
+			cmd.Dir = mockProjectDir
+			output, err := cmd.CombinedOutput()
+
+			By("expecting the command to fail due to merge conflicts")
+			Expect(err).To(HaveOccurred())
+			Expect(string(output)).To(ContainSubstring("Merge stopped due to conflicts"))
+			Expect(string(output)).To(ContainSubstring("merge stopped due to conflicts"))
+		})
+
+		It("should commit with conflict markers when --force is used", func() {
+			// Download the conflicts version binary for this test
+			conflictsBinPath, err := downloadKubebuilderVersion(fromVersionWithConflicts)
+			Expect(err).NotTo(HaveOccurred())
+			defer func() { _ = os.RemoveAll(filepath.Dir(conflictsBinPath)) }()
+
+			By("creating mock project with kubebuilder " + fromVersionWithConflicts)
+			createMockProject(mockProjectDir, conflictsBinPath)
+
+			By("initializing git repository and committing mock project")
+			initializeGitRepo(mockProjectDir)
+
+			By("running alpha update with --force flag")
+			cmd := exec.Command(kbc.BinaryName, "alpha", "update",
+				"--from-version", fromVersionWithConflicts, "--to-version", toVersion, "--from-branch", "main", "--force")
+			cmd.Dir = mockProjectDir
+			output, err := cmd.CombinedOutput()
+
+			By("expecting the command to succeed despite conflicts")
+			Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Alpha update with --force failed: %s", string(output)))
+
+			By("validating that conflict markers are present in the merged files")
+			validateConflictMarkers(mockProjectDir)
+		})
 	})
 })
 
 // downloadKubebuilder downloads the --from-version kubebuilder binary to a temporary directory
-func downloadKubebuilder() (string, error) {
-	binaryDir, err := os.MkdirTemp("", "kubebuilder-v4.5.2-")
+func downloadKubebuilderVersion(version string) (string, error) {
+	binaryDir, err := os.MkdirTemp("", "kubebuilder-"+version+"-")
 	if err != nil {
 		return "", fmt.Errorf("failed to create binary directory: %w", err)
 	}
 
 	url := fmt.Sprintf(
 		"https://github.com/kubernetes-sigs/kubebuilder/releases/download/%s/kubebuilder_%s_%s",
-		fromVersion,
+		version,
 		runtime.GOOS,
 		runtime.GOARCH,
 	)
 	binaryPath := filepath.Join(binaryDir, "kubebuilder")
 
 	resp, err := http.Get(url)
 	if err != nil {
-		return "", fmt.Errorf("failed to download kubebuilder %s: %w", fromVersion, err)
+		return "", fmt.Errorf("failed to download kubebuilder %s: %w", version, err)
 	}
 	defer func() { _ = resp.Body.Close() }()
 
 	if resp.StatusCode != http.StatusOK {
-		return "", fmt.Errorf("failed to download kubebuilder %s: HTTP %d", fromVersion, resp.StatusCode)
+		return "", fmt.Errorf("failed to download kubebuilder %s: HTTP %d", version, resp.StatusCode)
 	}
 
 	file, err := os.Create(binaryPath)
@@ -263,7 +310,7 @@ func runAlphaUpdate(projectDir string, kbc *utils.TestContext) {
 
 	// Use TestContext to run alpha update command
 	cmd := exec.Command(kbc.BinaryName, "alpha", "update",
-		"--from-version", fromVersion, "--to-version", toVersion, "--from-branch", "main")
+		"--from-version", fromVersionWithoutConflicts, "--to-version", toVersion, "--from-branch", "main")
 	cmd.Dir = projectDir
 	output, err := cmd.CombinedOutput()
 	Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Alpha update failed: %s", string(output)))
@@ -283,3 +330,20 @@ func validateCustomCodePreservation(projectDir string) {
 	Expect(string(content)).To(ContainSubstring("log.Info(\"Reconciling TestOperator\")"))
 	Expect(string(content)).To(ContainSubstring("log.Info(\"TestOperator size\", \"size\", testOperator.Spec.Size)"))
 }
+
+func validateConflictMarkers(projectDir string) {
+	// Use git to check for conflict markers across the entire project
+	cmd := exec.Command("git", "grep", "-l", "^<<<<<<<\\|^=======\\|^>>>>>>>", ".")
+	cmd.Dir = projectDir
+	output, err := cmd.CombinedOutput()
+
+	// If git grep finds conflict markers, it returns exit code 0
+	// If no conflict markers are found, it returns exit code 1
+	if err == nil {
+		// Conflict markers found - this is expected
+		Expect(output).ToNot(BeEmpty(), "Expected conflict markers in merged files")
+	} else {
+		// No conflict markers found
+		Expect(false).To(BeTrue(), "Expected conflict markers in merged files but none were found")
+	}
+}