Merge pull request #26 from vitessio/enhance-code-freeze

Author: frouioui

go/cmd/interactive/cmd.go

@@ -32,7 +32,12 @@ func Command() *cobra.Command {
 		Run: func(cmd *cobra.Command, args []string) {
 			ctx := releaser.UnwrapCtx(cmd.Context())
 			git.CorrectCleanRepo(ctx.VitessRepo)
+
+			// TODO: The assumption that the Release Manager won't be
+			// modifying the release issue while using vitess-releaser
+			// is made here, perhaps there is a better way of doing it
 			ctx.LoadIssue()
+
 			interactive.MainScreen(ctx)
 		},
 	}

go/interactive/code_freeze.go

@@ -18,7 +18,6 @@ package interactive
 
 import (
 	tea "github.com/charmbracelet/bubbletea"
-	"vitess.io/vitess-releaser/go/interactive/state"
 	"vitess.io/vitess-releaser/go/releaser"
 	"vitess.io/vitess-releaser/go/releaser/steps"
 
@@ -31,24 +30,25 @@ func codeFreezeMenuItem(ctx *releaser.Context) *menuItem {
 		name:   steps.CodeFreeze,
 		act:    codeFreezeAct,
 		update: codeFreezeUpdate,
-		isDone: state.ToDo, // TODO: read the initial state from the Release Issue on GitHub
+		info:   ctx.Issue.CodeFreeze.URL,
+		isDone: ctx.Issue.CodeFreeze.Done,
 	}
 }
 
 type codeFreezeUrl string
 
 func codeFreezeUpdate(mi *menuItem, msg tea.Msg) (*menuItem, tea.Cmd) {
-	url, ok := msg.(codeFreezeUrl)
+	_, ok := msg.(codeFreezeUrl)
 	if !ok {
 		return mi, nil
 	}
-	mi.info = string(url)
-	mi.isDone = state.Done
+
+	mi.info = mi.ctx.Issue.CodeFreeze.URL
+	mi.isDone = mi.ctx.Issue.CodeFreeze.Done
 	return mi, nil
 }
 
 func codeFreezeAct(mi *menuItem) (*menuItem, tea.Cmd) {
-	mi.info = "running..."
 	pl, freeze := pre_release.CodeFreeze(mi.ctx)
 	return mi, tea.Batch(func() tea.Msg {
 		return codeFreezeUrl(freeze())

go/interactive/create_github_milestones.go

@@ -42,7 +42,7 @@ func createMilestoneMenuItem(ctx *releaser.Context) *menuItem {
 
 func createMilestoneUpdate(mi *menuItem, msg tea.Msg) (*menuItem, tea.Cmd) {
 	milestoneLink, ok := msg.(createMilestone)
-	if !ok || milestoneLink == "" {
+	if !ok || len(milestoneLink) == 0 {
 		return mi, nil
 	}
 

go/releaser/git/git.go

@@ -59,7 +59,12 @@ func Pull(remote, branch string) {
 }
 
 func ResetHard(remote, branch string) {
-	out, err := exec.Command("git", "reset", "--hard", remote+"/"+branch).CombinedOutput()
+	out, err := exec.Command("git", "fetch", remote).CombinedOutput()
+	if err != nil {
+		log.Fatalf("%s: %s", err, out)
+	}
+
+	out, err = exec.Command("git", "reset", "--hard", remote+"/"+branch).CombinedOutput()
 	if err != nil {
 		log.Fatalf("%s: %s", err, out)
 	}
@@ -83,16 +88,20 @@ func Push(remote, branch string) {
 	}
 }
 
-func CommitAll(msg string) {
+func CommitAll(msg string) (empty bool) {
 	out, err := exec.Command("git", "add", "--all").CombinedOutput()
 	if err != nil {
 		log.Fatalf("%s: %s", err, out)
 	}
 
 	out, err = exec.Command("git", "commit", "-n", "-s", "-m", msg).CombinedOutput()
 	if err != nil {
+		if strings.Contains(err.Error(), "nothing to commit, working tree clean") {
+			return true
+		}
 		log.Fatalf("%s: %s", err, out)
 	}
+	return false
 }
 
 // FindRemoteName takes the output of `git remote -v` and a repository name,

go/releaser/github/pr.go

@@ -20,6 +20,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"strconv"
 	"strings"
 
 	gh "github.com/cli/go-gh"
@@ -39,7 +40,7 @@ type PR struct {
 	Labels []Label `json:"labels"`
 }
 
-func (p *PR) Create(repo string) string {
+func (p *PR) Create(repo string) (nb int, url string) {
 	var labels []string
 	for _, label := range p.Labels {
 		labels = append(labels, label.Name)
@@ -56,15 +57,28 @@ func (p *PR) Create(repo string) string {
 	if err != nil {
 		log.Fatal(err)
 	}
-	return strings.ReplaceAll(stdOut.String(), "\n", "")
+	url = strings.ReplaceAll(stdOut.String(), "\n", "")
+	nb = URLToNb(url)
+	return nb, url
 }
 
-func FormatPRs(prs []PR) []string {
-	var prFmt []string
-	for _, pr := range prs {
-		prFmt = append(prFmt, fmt.Sprintf(" -> %s  %s", pr.URL, pr.Title))
+func IsPRMerged(repo string, nb int) bool {
+	stdOut, _, err := gh.Exec(
+		"pr", "view", strconv.Itoa(nb),
+		"--repo", repo,
+		"--json", "mergedAt",
+	)
+	if err != nil {
+		log.Fatal(err)
 	}
-	return prFmt
+
+	// If the PR is not merged, the output of the gh command will be:
+	// {
+	//  "mergedAt": null
+	// }
+	//
+	// We can then grep for "null", if present, the PR has not been merged yet.
+	return !strings.Contains(stdOut.String(), "null")
 }
 
 func CheckBackportToPRs(repo, majorRelease string) []PR {
@@ -95,3 +109,26 @@ func CheckBackportToPRs(repo, majorRelease string) []PR {
 	}
 	return mustClose
 }
+
+func FindCodeFreezePR(repo, prTitle string) (nb int, url string) {
+	byteRes, _, err := gh.Exec(
+		"pr", "list",
+		"--json", "url",
+		"--repo", repo,
+		"--search", prTitle,
+		"--state", "open",
+	)
+	if err != nil {
+		log.Fatalf(err.Error())
+	}
+	var prs []PR
+	err = json.Unmarshal(byteRes.Bytes(), &prs)
+	if err != nil {
+		log.Fatalf(err.Error())
+	}
+	if len(prs) != 1 {
+		return 0, ""
+	}
+	url = prs[0].URL
+	return URLToNb(url), url
+}

go/releaser/issue.go

@@ -58,9 +58,9 @@ type (
 	ItemWithLink struct {
 		Done bool
 
-		// URL always uses the following format: "#111"
-		// Expect for GH milestones, where the HTTP
-		// version is used, such as "https://github.com...."
+		// URL can use two formats:
+		// 	- GH links:		"#111"
+		//  - HTTP links:	"https://github.com...."
 		URL string
 	}
 
@@ -178,6 +178,9 @@ func (ctx *Context) LoadIssue() {
 					s = stateReadingNewMilestoneItem
 				}
 			}
+			if strings.Contains(line, postSlackAnnouncementItem) {
+				newIssue.SlackPostRelease = strings.HasPrefix(line, markdownItemDone)
+			}
 		case stateReadingBackport:
 			newIssue.CheckBackport.Items = append(newIssue.CheckBackport.Items, handleNewListItem(lines, i, &s))
 		case stateReadingReleaseBlockerIssue:

go/releaser/pre_release/code_freeze.go

@@ -20,7 +20,10 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"os"
 	"os/exec"
+	"strings"
+	"time"
 
 	"vitess.io/vitess-releaser/go/releaser"
 	"vitess.io/vitess-releaser/go/releaser/git"
@@ -42,37 +45,92 @@ const (
 // Request must be forced-merged by a Vitess maintainer, this step cannot be automated.
 func CodeFreeze(ctx *releaser.Context) (*logging.ProgressLogging, func() string) {
 	pl := &logging.ProgressLogging{
-		TotalSteps: 6,
+		TotalSteps: 12,
 	}
 
+	waitForPRToBeMerged := func(nb int) {
+		pl.NewStepf("Waiting for the PR to be merged. You must enable bypassing the branch protection rules in: https://github.com/vitessio/vitess/settings/branches")
+	outer:
+		for {
+			select {
+			case <-time.After(5 * time.Second):
+				if github.IsPRMerged(ctx.VitessRepo, nb) {
+					break outer
+				}
+			}
+		}
+		pl.NewStepf("PR has been merged")
+	}
+
+	var done bool
+	var url string
+	var nb int
 	return pl, func() string {
+		defer func() {
+			ctx.Issue.CodeFreeze.Done = done
+			ctx.Issue.CodeFreeze.URL = url
+			pl.NewStepf("Update Issue %s on GitHub", ctx.IssueLink)
+			_, fn := ctx.UploadIssue()
+			issueLink := fn()
+
+			pl.NewStepf("Issue updated, see: %s", issueLink)
+		}()
+
 		git.CorrectCleanRepo(ctx.VitessRepo)
 		nextRelease, branchName := releaser.FindNextRelease(ctx.MajorRelease)
 
 		pl.NewStepf("Fetch from git remote")
 		remote := git.FindRemoteName(ctx.VitessRepo)
 		git.ResetHard(remote, branchName)
 
+		codeFreezePRName := fmt.Sprintf("[%s] Code Freeze for `v%s`", branchName, nextRelease)
+
+		// look for existing code freeze PRs
+		pl.NewStepf("Look for existing an Code Freeze Pull Request")
+		if nb, url = github.FindCodeFreezePR(ctx.VitessRepo, codeFreezePRName); url != "" {
+			pl.TotalSteps = 7 // only 7 total steps in this situation
+			pl.NewStepf("An opened Code Freeze Pull Request was found: %s", url)
+			waitForPRToBeMerged(nb)
+			done = true
+			return url
+		}
+
+		// check if the branch is already frozen or not
+		pl.NewStepf("Check if branch %s is already frozen", branchName)
+		if isCurrentBranchFrozen() {
+			pl.TotalSteps = 6 // only 6 total steps in this situation
+			pl.NewStepf("Branch %s is already frozen, no action needed.", branchName)
+			done = true
+			return ""
+		}
+
 		pl.NewStepf("Create new branch based on %s/%s", remote, branchName)
 		newBranchName := findNewBranchForCodeFreeze(remote, branchName)
 
 		pl.NewStepf("Turn on code freeze on branch %s", newBranchName)
 		activateCodeFreeze()
 
 		pl.NewStepf("Commit and push to branch %s", newBranchName)
-		git.CommitAll(fmt.Sprintf("Code Freeze of %s", branchName))
+		if git.CommitAll(fmt.Sprintf("Code Freeze of %s", branchName)) {
+			pl.TotalSteps = 9 // only 9 total steps in this situation
+			pl.NewStepf("Nothing to commit, seems like code freeze is already done.", newBranchName)
+			done = true
+			return ""
+		}
 		git.Push(remote, newBranchName)
 
 		pl.NewStepf("Create Pull Request")
 		pr := github.PR{
-			Title:  fmt.Sprintf("[%s] Code Freeze for `v%s`", branchName, nextRelease),
+			Title:  codeFreezePRName,
 			Body:   fmt.Sprintf("This Pull Request freezes the branch `%s` for `v%s`", branchName, nextRelease),
 			Branch: newBranchName,
 			Base:   branchName,
 			Labels: []github.Label{{Name: "Component: General"}, {Name: "Type: Release"}},
 		}
-		url := pr.Create(ctx.VitessRepo)
+		nb, url = pr.Create(ctx.VitessRepo)
 		pl.NewStepf("PR created %s", url)
+		waitForPRToBeMerged(nb)
+		done = true
 		return url
 	}
 }
@@ -95,6 +153,15 @@ func findNewBranchForCodeFreeze(remote, baseBranch string) string {
 	return newBranch
 }
 
+func isCurrentBranchFrozen() bool {
+	b, err := os.ReadFile(codeFreezeWorkflowFile)
+	if err != nil {
+		log.Fatal(err)
+	}
+	str := string(b)
+	return strings.Contains(str, "exit 1")
+}
+
 func activateCodeFreeze() {
 	changeCodeFreezeWorkflow(codeFreezeActivated)
 }