Merge pull request #45 from vitessio/release-notes-on-main

Copy release notes to main branch

Author: frouioui

go/interactive/release/release_notes_to_main.go

@@ -22,6 +22,7 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 	"vitess.io/vitess-releaser/go/interactive/ui"
 	"vitess.io/vitess-releaser/go/releaser"
+	"vitess.io/vitess-releaser/go/releaser/release"
 	"vitess.io/vitess-releaser/go/releaser/steps"
 )
 
@@ -44,9 +45,19 @@ func ReleaseNotesOnMainItem(ctx context.Context) *ui.MenuItem {
 type releaseNotesOnMainUrl string
 
 func releaseNotesOnMainUpdate(mi *ui.MenuItem, msg tea.Msg) (*ui.MenuItem, tea.Cmd) {
+	_, ok := msg.(releaseNotesOnMainUrl)
+	if !ok {
+		return mi, nil
+	}
+
+	mi.Info = mi.State.Issue.CodeFreeze.URL
+	mi.IsDone = mi.State.Issue.CodeFreeze.Done
 	return mi, nil
 }
 
 func releaseNotesOnMainAct(mi *ui.MenuItem) (*ui.MenuItem, tea.Cmd) {
-	return mi, nil
+	pl, fn := release.ReleaseNotesOnMain(mi.State)
+	return mi, tea.Batch(func() tea.Msg {
+		return releaseNotesOnMainUrl(fn())
+	}, ui.PushDialog(ui.NewProgressDialog("Release Notes on Main", pl)))
 }

go/releaser/git/git.go

@@ -178,3 +178,10 @@ func GetSHAForGitRef(ref string) string {
 	}
 	return strings.ReplaceAll(string(out), "\n", "")
 }
+
+func CheckoutPath(remote, branch, path string) {
+	out, err := exec.Command("git", "checkout", fmt.Sprintf("%s/%s", remote, branch), path).CombinedOutput()
+	if err != nil {
+		log.Fatalf("%s: %s", err, out)
+	}
+}

go/releaser/pre_release/code_freeze.go

@@ -112,7 +112,7 @@ func CodeFreeze(state *releaser.State) (*logging.ProgressLogging, func() string)
 		pl.NewStepf("Commit and push to branch %s", newBranchName)
 		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)
+			pl.NewStepf("Nothing to commit, seems like code freeze is already done.")
 			done = true
 			return ""
 		}

go/releaser/pre_release/release_notes.go

@@ -116,6 +116,16 @@ The entire changelog for this release can be found [here]({{ .PathToChangeLogFil
 )
 
 func GetReleaseNotesDirPath(version string) string {
+	prefix, major, patch := getSegmentOfReleaseNotesDir(version)
+	return path.Join(prefix, major, patch)
+}
+
+func GetReleaseNotesDirPathForMajor(version string) string {
+	prefix, major, _ := getSegmentOfReleaseNotesDir(version)
+	return path.Join(prefix, major)
+}
+
+func getSegmentOfReleaseNotesDir(version string) (prefix string, major string, patch string) {
 	// There should be 4 sub-matches, input: "14.0.0", output: ["14.0.0", "14", "0", "0"].
 	rx := regexp.MustCompile(`([0-9]+)\.([0-9]+)\.([0-9]+)`)
 	versionMatch := rx.FindStringSubmatch(version)
@@ -125,7 +135,7 @@ func GetReleaseNotesDirPath(version string) string {
 
 	majorVersion := versionMatch[1] + "." + versionMatch[2]
 	patchVersion := versionMatch[1] + "." + versionMatch[2] + "." + versionMatch[3]
-	return path.Join(releaseNotesPathPrefix, majorVersion, patchVersion)
+	return releaseNotesPathPrefix, majorVersion, patchVersion
 }
 
 func generateReleaseNotes(state *releaser.State, version string) {

go/releaser/release/release_notes_on_main.go

@@ -0,0 +1,96 @@
+/*
+Copyright 2023 The Vitess Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package release
+
+import (
+	"fmt"
+
+	"vitess.io/vitess-releaser/go/releaser"
+	"vitess.io/vitess-releaser/go/releaser/git"
+	"vitess.io/vitess-releaser/go/releaser/github"
+	"vitess.io/vitess-releaser/go/releaser/logging"
+	"vitess.io/vitess-releaser/go/releaser/pre_release"
+)
+
+func ReleaseNotesOnMain(state *releaser.State) (*logging.ProgressLogging, func() string) {
+	pl := &logging.ProgressLogging{
+		TotalSteps: 9,
+	}
+
+	var done bool
+	var url string
+	return pl, func() string {
+		defer func() {
+			state.Issue.ReleaseNotesOnMain.Done = done
+			state.Issue.ReleaseNotesOnMain.URL = url
+			pl.NewStepf("Update Issue %s on GitHub", state.IssueLink)
+			_, fn := state.UploadIssue()
+			issueLink := fn()
+
+			pl.NewStepf("Issue updated, see: %s", issueLink)
+		}()
+
+		git.CorrectCleanRepo(state.VitessRepo)
+		nextRelease, branchName, _ := releaser.FindNextRelease(state.MajorRelease)
+
+		pl.NewStepf("Fetch from git remote")
+		remote := git.FindRemoteName(state.VitessRepo)
+		git.ResetHard(remote, branchName)
+
+		git.Checkout("main")
+		git.ResetHard(remote, "main")
+
+		prName := fmt.Sprintf("Copy `v%s` release notes on `main`", nextRelease)
+
+		pl.NewStepf("Look for an existing Pull Request named '%s'", prName)
+		if _, url = github.FindPR(state.VitessRepo, prName); url != "" {
+			pl.TotalSteps = 5 // only 5 total steps in this situation
+			pl.NewStepf("An opened Pull Request was found: %s", url)
+			done = true
+			return url
+		}
+
+		pl.NewStepf("Create new branch based on %s/main", remote)
+		newBranchName := git.FindNewGeneratedBranch(remote, "main", "release-notes-main")
+
+		pl.NewStepf("Copy release notes from %s/%s", remote, branchName)
+		releaseNotesPath := pre_release.GetReleaseNotesDirPathForMajor(nextRelease)
+		git.CheckoutPath(remote, branchName, releaseNotesPath)
+
+		pl.NewStepf("Commit and push to branch %s", newBranchName)
+		if git.CommitAll(fmt.Sprintf("Copy release notes from %s into main", branchName)) {
+			pl.TotalSteps = 8 // only 8 total steps in this situation
+			pl.NewStepf("Nothing to commit, seems like the release notes have already been copied")
+			done = true
+			return ""
+		}
+		git.Push(remote, newBranchName)
+
+		pl.NewStepf("Create Pull Request")
+		pr := github.PR{
+			Title:  prName,
+			Body:   fmt.Sprintf("This Pull Request copies the release notes found on `%s` to keep release notes up-to-date after the `v%s` release.", branchName, nextRelease),
+			Branch: newBranchName,
+			Base:   "main",
+			Labels: []github.Label{{Name: "Component: General"}, {Name: "Type: Release"}},
+		}
+		_, url = pr.Create(state.VitessRepo)
+		pl.NewStepf("Pull Request created %s", url)
+		done = true
+		return url
+	}
+}