Merge pull request #5018 from camilamacedo86/open-pr

✨ (alpha update) Add option to allow open GitHub Issues after updates

Author: k8s-ci-robot

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

@@ -27,6 +27,8 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/config/store"
 )
 
+const defaultBranch = "main"
+
 type releaseResponse struct {
 	TagName string `json:"tag_name"`
 }
@@ -37,7 +39,7 @@ func (opts *Update) Prepare() error {
 	if opts.FromBranch == "" {
 		// TODO: Check if is possible to use get to determine the default branch
 		log.Warn("No --from-branch specified, using 'main' as default")
-		opts.FromBranch = "main"
+		opts.FromBranch = defaultBranch
 	}
 
 	path, err := common.GetInputPath("")

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

@@ -17,6 +17,7 @@ limitations under the License.
 package update
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 
@@ -35,18 +36,30 @@ var _ = Describe("Prepare for internal update", func() {
 		tmpDir      string
 		workDir     string
 		projectFile string
+		mockGh      string
 		err         error
+
+		logFile string
+		oldPath string
+		opts    Update
 	)
 
 	BeforeEach(func() {
 		workDir, err = os.Getwd()
 		Expect(err).ToNot(HaveOccurred())
 
+		// 1) Create tmp dir and chdir first
 		tmpDir, err = os.MkdirTemp("", "kubebuilder-prepare-test")
 		Expect(err).ToNot(HaveOccurred())
 		err = os.Chdir(tmpDir)
 		Expect(err).ToNot(HaveOccurred())
 
+		// 2) Now that tmpDir exists, set logFile and PATH
+		logFile = filepath.Join(tmpDir, "bin.log")
+
+		oldPath = os.Getenv("PATH")
+		Expect(os.Setenv("PATH", tmpDir+string(os.PathListSeparator)+oldPath)).To(Succeed())
+
 		projectFile = filepath.Join(tmpDir, yaml.DefaultPath)
 
 		config.Register(config.Version{Number: 3}, func() config.Config {
@@ -56,12 +69,25 @@ var _ = Describe("Prepare for internal update", func() {
 		gock.New("https://api.github.com").
 			Get("/repos/kubernetes-sigs/kubebuilder/releases/latest").
 			Reply(200).
-			JSON(map[string]string{
-				"tag_name": "v1.1.0",
-			})
+			JSON(map[string]string{"tag_name": "v1.1.0"})
+
+		// 3) Create the mock gh inside tmpDir (on PATH)
+		mockGh = filepath.Join(tmpDir, "gh")
+		ghOK := `#!/bin/bash
+echo "$@" >> "` + logFile + `"
+if [[ "$1" == "repo" && "$2" == "view" ]]; then
+  echo "acme/repo"
+  exit 0
+fi
+if [[ "$1" == "issue" && "$2" == "create" ]]; then
+  exit 0
+fi
+exit 0`
+		Expect(mockBinResponse(ghOK, mockGh)).To(Succeed())
 	})
 
 	AfterEach(func() {
+		Expect(os.Setenv("PATH", oldPath)).To(Succeed())
 		err = os.Chdir(workDir)
 		Expect(err).ToNot(HaveOccurred())
 
@@ -102,7 +128,7 @@ var _ = Describe("Prepare for internal update", func() {
 				const version = ""
 				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
 
-				err := options.Prepare()
+				err = options.Prepare()
 				Expect(err).To(HaveOccurred())
 				Expect(err.Error()).Should(ContainSubstring("failed to load PROJECT config"))
 			},
@@ -129,10 +155,10 @@ var _ = Describe("Prepare for internal update", func() {
 				const version = `version: "3"`
 				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
 
-				config, err := common.LoadProjectConfig(tmpDir)
-				Expect(err).ToNot(HaveOccurred())
-				fromVersion, err := options.defineFromVersion(config)
-				Expect(err).ToNot(HaveOccurred())
+				config, errLoad := common.LoadProjectConfig(tmpDir)
+				Expect(errLoad).ToNot(HaveOccurred())
+				fromVersion, errLoad := options.defineFromVersion(config)
+				Expect(errLoad).ToNot(HaveOccurred())
 				Expect(fromVersion).To(BeEquivalentTo("v1.0.0"))
 			},
 			Entry("options", &Update{FromVersion: ""}),
@@ -147,11 +173,11 @@ var _ = Describe("Prepare for internal update", func() {
 				const version = `version: "3"`
 				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
 
-				config, err := common.LoadProjectConfig(tmpDir)
-				Expect(err).NotTo(HaveOccurred())
-				fromVersion, err := options.defineFromVersion(config)
-				Expect(err).To(HaveOccurred())
-				Expect(err.Error()).To(ContainSubstring("no version specified in PROJECT file"))
+				config, errLoad := common.LoadProjectConfig(tmpDir)
+				Expect(errLoad).NotTo(HaveOccurred())
+				fromVersion, errLoad := options.defineFromVersion(config)
+				Expect(errLoad).To(HaveOccurred())
+				Expect(errLoad.Error()).To(ContainSubstring("no version specified in PROJECT file"))
 				Expect(fromVersion).To(Equal(""))
 			},
 			Entry("options", &Update{FromVersion: ""}),
@@ -169,4 +195,78 @@ var _ = Describe("Prepare for internal update", func() {
 			Entry("options", &Update{}),
 		)
 	})
+
+	Context("OpenGitHubIssue", func() {
+		It("creates issue without conflicts", func() {
+			opts.FromBranch = defaultBranch
+			opts.FromVersion = "v4.5.1"
+			opts.ToVersion = "v4.8.0"
+
+			err = opts.openGitHubIssue(false)
+			Expect(err).ToNot(HaveOccurred())
+
+			logs, readErr := os.ReadFile(logFile)
+			Expect(readErr).ToNot(HaveOccurred())
+			s := string(logs)
+
+			Expect(s).To(ContainSubstring("repo view --json nameWithOwner --jq .nameWithOwner"))
+			Expect(s).To(ContainSubstring("issue create"))
+
+			expURL := fmt.Sprintf("https://github.com/%s/compare/%s...%s?expand=1",
+				"acme/repo", opts.FromBranch, opts.getOutputBranchName())
+			Expect(s).To(ContainSubstring(expURL))
+			Expect(s).To(ContainSubstring(opts.ToVersion))
+			Expect(s).To(ContainSubstring(opts.FromVersion))
+		})
+
+		It("creates issue with conflicts template", func() {
+			opts.FromBranch = defaultBranch
+			opts.FromVersion = "v4.5.2"
+			opts.ToVersion = "v4.10.0"
+
+			err = opts.openGitHubIssue(true)
+			Expect(err).ToNot(HaveOccurred())
+
+			logs, _ := os.ReadFile(logFile)
+			s := string(logs)
+			Expect(s).To(ContainSubstring("Resolve conflicts"))
+			Expect(s).To(ContainSubstring("make manifests generate fmt vet lint-fix"))
+		})
+
+		It("fails when repo detection fails", func() {
+			failRepo := `#!/bin/bash
+echo "$@" >> "` + logFile + `"
+if [[ "$1" == "repo" && "$2" == "view" ]]; then
+  exit 1
+fi
+exit 0`
+			Expect(mockBinResponse(failRepo, mockGh)).To(Succeed())
+
+			err = opts.openGitHubIssue(false)
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("failed to detect GitHub repository"))
+		})
+
+		It("fails when issue creation fails", func() {
+			failIssue := `#!/bin/bash
+echo "$@" >> "` + logFile + `"
+if [[ "$1" == "repo" && "$2" == "view" ]]; then
+  echo "acme/repo"
+  exit 0
+fi
+if [[ "$1" == "issue" && "$2" == "create" ]]; then
+  exit 1
+fi
+exit 0`
+			Expect(mockBinResponse(failIssue, mockGh)).To(Succeed())
+
+			opts.FromBranch = defaultBranch
+			opts.FromVersion = "v4.5.0"
+			opts.ToVersion = "v4.6.0"
+
+			err = opts.openGitHubIssue(false)
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("failed to create GitHub Issue"))
+		})
+	})
 })

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

@@ -71,6 +71,12 @@ type Update struct {
 	// Push, when true, pushes the OutputBranch to the "origin" remote after the update completes.
 	Push bool
 
+	// OpenGhIssue, when true, automatically creates a GitHub issue after the update
+	// completes. The issue includes a pre-filled checklist and a compare link from
+	// the base branch (--from-branch) to the output branch. This requires the GitHub
+	// CLI (`gh`) to be installed and authenticated in the local environment.
+	OpenGhIssue bool
+
 	// Temporary branches created during the update process. These are internal to the run
 	// and are surfaced for transparency/debugging:
 	//   - AncestorBranch: clean scaffold generated from FromVersion
@@ -83,6 +89,73 @@ type Update struct {
 	MergeBranch    string
 }
 
+const issueTitleTmpl = "[Action Required] Upgrade the Scaffold: %[2]s -> %[1]s"
+
+//nolint:lll
+const issueBodyTmpl = `## Description
+
+Upgrade your project to use the latest scaffold changes introduced in Kubebuilder [%[1]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[1]s).  
+
+See the release notes from [%[3]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[3]s) to [%[1]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[1]s) for details about the changes included in this upgrade.
+
+## What to do
+
+A scheduled workflow already attempted this upgrade and created the branch %[4]s to help you in this process.
+
+Create a Pull Request using the URL below to review the changes:
+%[2]s  
+
+## Next steps
+
+Verify the changes
+- Build the project  
+- Run tests  
+- Confirm everything still works
+
+:book: **More info:** https://kubebuilder.io/reference/commands/alpha_update
+`
+
+//nolint:lll
+const issueBodyTmplWithConflicts = `## Description
+
+Upgrade your project to use the latest scaffold changes introduced in Kubebuilder [%[1]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[1]s).  
+
+See the release notes from [%[3]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[3]s) to [%[1]s](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/%[1]s) for details about the changes included in this upgrade.
+
+## What to do
+
+A scheduled workflow already attempted this upgrade and created the branch (%[4]s) to help you in this process.
+
+:warning: **Conflicts were detected during the merge.**
+
+Create a Pull Request using the URL below to review the changes and resolve conflicts manually:
+%[2]s  
+
+## Next steps
+
+### 1. Resolve conflicts
+After fixing conflicts, run:
+~~~bash
+make manifests generate fmt vet lint-fix
+~~~
+
+### 2. Optional: work on a new branch
+To apply the update in a clean branch, run:
+~~~bash
+kubebuilder alpha update --output-branch my-fix-branch
+~~~
+
+This will create a new branch (my-fix-branch) with the update applied.  
+Resolve conflicts there, complete the merge locally, and push the branch.
+
+### 3. Verify the changes
+- Build the project  
+- Run tests  
+- Confirm everything still works
+
+:book: **More info:** https://kubebuilder.io/reference/commands/alpha_update
+`
+
 // Update a project using a default three-way Git merge.
 // This helps apply new scaffolding changes while preserving custom code.
 func (opts *Update) Update() error {
@@ -170,6 +243,68 @@ func (opts *Update) Update() error {
 	opts.cleanupTempBranches()
 	log.Info("Update completed successfully")
 
+	if opts.OpenGhIssue {
+		if err := opts.openGitHubIssue(hasConflicts); err != nil {
+			return fmt.Errorf("failed to open GitHub issue: %w", err)
+		}
+	}
+
+	return nil
+}
+
+func (opts *Update) openGitHubIssue(hasConflicts bool) error {
+	log.Info("Creating GitHub Issue to track the need to update the project")
+	out := opts.getOutputBranchName()
+	repoCmd := exec.Command("gh", "repo", "view", "--json",
+		"nameWithOwner", "--jq", ".nameWithOwner")
+	repoBytes, err := repoCmd.Output()
+	if err != nil {
+		return fmt.Errorf("failed to detect GitHub repository via `gh repo view`: %s", err)
+	}
+
+	repo := strings.TrimSpace(string(repoBytes))
+	createPRURL := fmt.Sprintf("https://github.com/%s/compare/%s...%s?expand=1",
+		repo, opts.FromBranch, out)
+
+	title := fmt.Sprintf(issueTitleTmpl, opts.ToVersion, opts.FromVersion)
+
+	// check if an issue with the same title already exists
+	checkCmd := exec.Command("gh", "issue", "list",
+		"--search", fmt.Sprintf("in:title \"%s\"", title),
+		"--json", "title")
+	checkOut, checkErr := checkCmd.Output()
+	if checkErr == nil && strings.Contains(string(checkOut), title) {
+		log.Info("GitHub Issue already exists, skipping creation", "title", title)
+		return nil
+	}
+
+	var body string
+	if hasConflicts {
+		body = fmt.Sprintf(issueBodyTmplWithConflicts,
+			opts.ToVersion,   // %[1]s -> ToVersion
+			createPRURL,      // %[2]s -> PR compare URL
+			opts.FromVersion, // %[3]s -> FromVersion
+			out,              // %[4]s -> OutputBranch
+		)
+	} else {
+		body = fmt.Sprintf(issueBodyTmpl,
+			opts.ToVersion,   // %[1]s -> ToVersion
+			createPRURL,      // %[2]s -> PR compare URL
+			opts.FromVersion, // %[3]s -> FromVersion
+			out,              // %[4]s -> OutputBranch
+		)
+	}
+
+	issueCmd := exec.Command("gh", "issue", "create",
+		"--title", title,
+		"--body", body,
+	)
+	issueCmd.Stdout = os.Stdout
+	issueCmd.Stderr = os.Stderr
+	if err := issueCmd.Run(); err != nil {
+		return fmt.Errorf("failed to create GitHub Issue: %s", err)
+	}
+	log.Info("GitHub Issue created to track the update", "pr", createPRURL)
 	return nil
 }
 

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

@@ -72,7 +72,7 @@ var _ = Describe("Prepare for internal update", func() {
 		opts = Update{
 			FromVersion: "v4.5.0",
 			ToVersion:   "v4.6.0",
-			FromBranch:  "main",
+			FromBranch:  defaultBranch,
 		}
 
 		// Create temporary directory to house fake bin executables.
@@ -444,7 +444,7 @@ exit 0`
 
 	Context("SquashToOutputBranch", func() {
 		BeforeEach(func() {
-			opts.FromBranch = "main"
+			opts.FromBranch = defaultBranch
 			opts.FromVersion = "v4.5.0"
 			opts.ToVersion = "v4.6.0"
 			if opts.MergeBranch == "" {

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

@@ -49,6 +49,14 @@ func (opts *Update) Validate() error {
 	if err := validateReleaseAvailability(opts.ToVersion); err != nil {
 		return fmt.Errorf("unable to find release %s: %w", opts.ToVersion, err)
 	}
+
+	if opts.OpenGhIssue {
+		if err := exec.Command("gh", "--version").Run(); err != nil {
+			return fmt.Errorf("`gh` CLI not found or not authenticated. "+
+				"You must have gh instaled to use the --open-gh-issue option: %s", err)
+		}
+	}
+
 	return nil
 }