internal/task: add step to publish announcement in gopls release flow

For golang/go#57643

Change-Id: I2f95f961648c9aa9a8c126982cace1a7814ae9a1
Reviewed-on: https://go-review.googlesource.com/c/build/+/611475
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Robert Findley <[email protected]>

Author: h9jiang

internal/task/announce.go

@@ -363,6 +363,8 @@ func announcementMail(data any) (MailContent, error) {
 		}
 	case releasePreAnnouncement:
 		name = "pre-announce-minor.md"
+	case goplsReleaseAnnouncement:
+		name = "gopls-announce.md"
 	case goplsPrereleaseAnnouncement:
 		name = "gopls-pre-announce.md"
 	default:
@@ -466,7 +468,7 @@ var announceTmpl = template.Must(template.New("").Funcs(template.FuncMap{
 		}
 		return "", fmt.Errorf("internal error: unhandled pre-release Go version %q", v)
 	},
-}).ParseFS(tmplDir, "template/announce-*.md", "template/pre-announce-minor.md", "template/gopls-pre-announce.md"))
+}).ParseFS(tmplDir, "template/announce-*.md", "template/pre-announce-minor.md", "template/gopls-announce.md", "template/gopls-pre-announce.md"))
 
 //go:embed template
 var tmplDir embed.FS

internal/task/announce_test.go

@@ -150,6 +150,15 @@ This is CVE-2022-27536 and https://go.dev/issue/51759.`,
 			},
 			wantSubject: "Gopls v0.16.2-pre.1 is released",
 		},
+		{
+			name: "gopls-announce",
+			in: goplsReleaseAnnouncement{
+				Version: "v0.16.2",
+				Branch:  "gopls-release-branch.0.16",
+				Commit:  "abc123def456ghi789",
+			},
+			wantSubject: "Gopls v0.16.2 is released",
+		},
 	}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {

internal/task/releasegopls.go

@@ -59,7 +59,7 @@ func (r *ReleaseGoplsTasks) NewPrereleaseDefinition() *wf.Definition {
 	verified := wf.Action1(wd, "verify installing latest gopls using release branch dependency commit", r.verifyGoplsInstallation, dependencyCommit)
 	prereleaseVersion := wf.Task3(wd, "tag pre-release", r.tagPrerelease, release, dependencyCommit, prerelease, wf.After(verified))
 	prereleaseVerified := wf.Action1(wd, "verify installing latest gopls using release branch pre-release version", r.verifyGoplsInstallation, prereleaseVersion)
-	wf.Action4(wd, "mail announcement", r.mailAnnouncement, release, prereleaseVersion, dependencyCommit, issue, wf.After(prereleaseVerified))
+	wf.Action4(wd, "mail announcement", r.mailPrereleaseAnnouncement, release, prereleaseVersion, dependencyCommit, issue, wf.After(prereleaseVerified))
 
 	vscodeGoChanges := wf.Task4(wd, "update gopls version in vscode-go", r.updateVSCodeGoGoplsVersion, reviewers, issue, release, prerelease, wf.After(prereleaseVerified))
 	_ = wf.Task1(wd, "await gopls version update CLs submission in vscode-go", clAwaiter{r.Gerrit}.awaitSubmissions, vscodeGoChanges)
@@ -484,10 +484,10 @@ type goplsPrereleaseAnnouncement struct {
 	Issue   int64
 }
 
-func (r *ReleaseGoplsTasks) mailAnnouncement(ctx *wf.TaskContext, semv semversion, prerelease, commit string, issue int64) error {
+func (r *ReleaseGoplsTasks) mailPrereleaseAnnouncement(ctx *wf.TaskContext, release semversion, rc, commit string, issue int64) error {
 	announce := goplsPrereleaseAnnouncement{
-		Version: prerelease,
-		Branch:  goplsReleaseBranchName(semv),
+		Version: rc,
+		Branch:  goplsReleaseBranchName(release),
 		Commit:  commit,
 		Issue:   issue,
 	}
@@ -501,6 +501,35 @@ func (r *ReleaseGoplsTasks) mailAnnouncement(ctx *wf.TaskContext, semv semversio
 	return r.SendMail(r.AnnounceMailHeader, content)
 }
 
+type goplsReleaseAnnouncement struct {
+	Version string
+	Branch  string
+	Commit  string
+}
+
+func (r *ReleaseGoplsTasks) mailReleaseAnnouncement(ctx *wf.TaskContext, release semversion) error {
+	version := fmt.Sprintf("v%v.%v.%v", release.Major, release.Minor, release.Patch)
+
+	info, err := r.Gerrit.GetTag(ctx, "tools", fmt.Sprintf("gopls/%s", version))
+	if err != nil {
+		return err
+	}
+
+	announce := goplsReleaseAnnouncement{
+		Version: version,
+		Branch:  goplsReleaseBranchName(release),
+		Commit:  info.Revision,
+	}
+	content, err := announcementMail(announce)
+	if err != nil {
+		return err
+	}
+	ctx.Printf("announcement subject: %s\n\n", content.Subject)
+	ctx.Printf("announcement body HTML:\n%s\n", content.BodyHTML)
+	ctx.Printf("announcement body text:\n%s", content.BodyText)
+	return r.SendMail(r.AnnounceMailHeader, content)
+}
+
 func (r *ReleaseGoplsTasks) isValidReleaseVersion(ctx *wf.TaskContext, ver string) error {
 	if !semver.IsValid(ver) {
 		return fmt.Errorf("the input %q version does not follow semantic version schema", ver)
@@ -643,6 +672,8 @@ func (r *ReleaseGoplsTasks) NewReleaseDefinition() *wf.Definition {
 	tagged := wf.Action2(wd, "tag the release", r.tagRelease, release, prerelease, wf.After(approved))
 
 	issue := wf.Task2(wd, "find release git issue", r.findOrCreateGitHubIssue, release, wf.Const(false))
+	_ = wf.Action1(wd, "mail announcement", r.mailReleaseAnnouncement, release, wf.After(tagged))
+
 	changeID := wf.Task3(wd, "updating x/tools dependency in master branch in gopls sub dir", r.updateDependencyIfMinor, reviewers, release, issue, wf.After(tagged))
 	_ = wf.Task1(wd, "await x/tools gopls dependency CL submission in gopls sub dir", clAwaiter{r.Gerrit}.awaitSubmission, changeID)
 

internal/task/releasegopls_test.go

@@ -1180,6 +1180,8 @@ case "$1" in
 esac
 `)
 
+			var gotSubject string // subject of the announcement email that was sent
+
 			tasks := &ReleaseGoplsTasks{
 				Gerrit:     gerrit,
 				CloudBuild: NewFakeCloudBuild(t, gerrit, "", nil, fakeGo),
@@ -1195,6 +1197,10 @@ esac
 						},
 					},
 				},
+				SendMail: func(h MailHeader, c MailContent) error {
+					gotSubject = c.Subject
+					return nil
+				},
 				ApproveAction: func(tc *workflow.TaskContext) error { return nil },
 			}
 
@@ -1305,6 +1311,11 @@ esac
 					t.Errorf("Content of %q = %q, want %q", check.path, got, check.want)
 				}
 			}
+
+			if wantSubject := fmt.Sprintf("Gopls v%v.%v.%v is released", tc.semv.Major, tc.semv.Minor, tc.semv.Patch); gotSubject != wantSubject {
+				// The full email content is checked by TestAnnouncementMail.
+				t.Errorf("NewReleaseDefinition().Run(): got email subject %q, want %q", gotSubject, wantSubject)
+			}
 		}
 		t.Run("manual input version: "+tc.name, func(t *testing.T) {
 			runTestWithInput(map[string]any{

internal/task/template/gopls-announce.md

@@ -0,0 +1,16 @@
+Subject: Gopls {{.Version}} is released
+
+Hello gophers,
+
+We have just released Gopls {{.Version}}. It is picked from release branch {{.Branch}} at commit {{.Commit | shortcommit}}.
+
+If you have Go installed already, an easy way to try {{.Version}} is by using the go command:
+
+```
+$ go install golang.org/x/tools/gopls@{{.Version}}
+```
+
+Thanks to everyone who contributed to the release.
+
+Cheers,
+The Go Tools Team

internal/task/testdata/gopls-announce.html

@@ -0,0 +1,8 @@
+<p>Hello gophers,</p>
+<p>We have just released Gopls v0.16.2. It is picked from release branch gopls-release-branch.0.16 at commit abc123d.</p>
+<p>If you have Go installed already, an easy way to try v0.16.2 is by using the go command:</p>
+<pre><code>$ go install golang.org/x/tools/[email protected]
+</code></pre>
+<p>Thanks to everyone who contributed to the release.</p>
+<p>Cheers,<br>
+The Go Tools Team</p>

internal/task/testdata/gopls-announce.txt

@@ -0,0 +1,12 @@
+Hello gophers,
+
+We have just released Gopls v0.16.2. It is picked from release branch gopls-release-branch.0.16 at commit abc123d.
+
+If you have Go installed already, an easy way to try v0.16.2 is by using the go command:
+
+$ go install golang.org/x/tools/[email protected]
+
+Thanks to everyone who contributed to the release.
+
+Cheers,
+The Go Tools Team