internal/relui: support communicating about a single minor release

CL 418789 added workflows to do a single minor release.
This adds corresponding support to the comm tasks.

Deal with the fact that the new single minor release kinds need more
communication parameters (for security information) in a verbose way
for now, and consider it as motivation to refactor the comm task API
to better fit relui's current needs in a followup change.

For golang/go#53537.

Change-Id: I99db09969151a3e83676ed2b59109011b53041c5
Reviewed-on: https://go-review.googlesource.com/c/build/+/419516
Run-TryBot: Dmitri Shuralyov <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Heschi Kreinick <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>

Author: dmitshur

internal/relui/workflows.go

@@ -128,8 +128,9 @@ The version string must use the same format as Go tags.`,
 		minorVersion.Example = "go1.18.2"
 		v1 := wd.Parameter(minorVersion)
 		v2 := wd.Parameter(workflow.Parameter{
-			Name:    "Secondary Version",
-			Doc:     `Secondary Version is an older Go version that was also released.`,
+			Name: "Secondary Version (optional)",
+			Doc: `Secondary Version is an older Go version that was also released,
+or the empty string if only one minor release was made.`,
 			Example: "go1.17.10",
 		})
 		securitySummary := wd.Parameter(securitySummaryParameter)
@@ -334,8 +335,9 @@ This is CVE-2022-24675 and Go issue https://go.dev/issue/51853.`,
 		minorVersion := version
 		minorVersion.Example = "go1.18.2"
 		secondaryVersion := workflow.Parameter{
-			Name:    "SecondaryVersion",
-			Doc:     `SecondaryVersion is an older Go version that was also released.`,
+			Name: "SecondaryVersion (optional)",
+			Doc: `SecondaryVersion is an older Go version that was also released,
+or the empty string if only one minor release was made.`,
 			Example: "go1.17.10",
 		}
 
@@ -418,8 +420,9 @@ It's applicable to all release types other than major
 		minorVersion := version
 		minorVersion.Example = "go1.18.2"
 		secondaryVersion := workflow.Parameter{
-			Name:    "SecondaryVersion",
-			Doc:     `SecondaryVersion is an older Go version that was also released.`,
+			Name: "SecondaryVersion (optional)",
+			Doc: `SecondaryVersion is an older Go version that was also released,
+or the empty string if only one minor release was made.`,
 			Example: "go1.17.10",
 		}
 
@@ -556,8 +559,12 @@ func RegisterReleaseWorkflows(ctx context.Context, h *DefinitionHolder, build *B
 	for _, r := range releases {
 		wd := workflow.New()
 
-		var names workflow.Value
+		var securitySummary, securityFixes, names workflow.Value
 		if mergeCommTasksIntoReleaseWorkflows {
+			if r.kind == task.KindCurrentMinor || r.kind == task.KindPrevMinor {
+				securitySummary = wd.Parameter(securitySummaryParameter)
+				securityFixes = wd.Parameter(securityFixesParameter)
+			}
 			names = wd.Parameter(releaseCoordinatorNames)
 		}
 
@@ -567,37 +574,7 @@ func RegisterReleaseWorkflows(ctx context.Context, h *DefinitionHolder, build *B
 		}
 
 		if mergeCommTasksIntoReleaseWorkflows {
-			okayToAnnounceAndTweet := wd.Action("Wait to Announce", build.ApproveAction, wd.After(versionPublished))
-
-			// Announce that a new Go release has been published.
-			sentMail := wd.Task("mail-announcement", func(ctx *workflow.TaskContext, v string, names []string) (task.SentMail, error) {
-				switch r.kind {
-				case task.KindMajor:
-					return comm.AnnounceMajorRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
-				case task.KindRC:
-					return comm.AnnounceRCRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
-				case task.KindBeta:
-					return comm.AnnounceBetaRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
-				default:
-					return task.SentMail{}, fmt.Errorf("unknown release kind %v", r.kind)
-				}
-			}, versionPublished, names, wd.After(okayToAnnounceAndTweet))
-			announcementURL := wd.Task("await-announcement", comm.AwaitAnnounceMail, sentMail)
-			tweetURL := wd.Task("post-tweet", func(ctx *workflow.TaskContext, v, ann string) (string, error) {
-				switch r.kind {
-				case task.KindMajor:
-					return comm.TweetMajorRelease(ctx, task.ReleaseTweet{Version: v})
-				case task.KindRC:
-					return comm.TweetRCRelease(ctx, task.ReleaseTweet{Version: v, Announcement: ann})
-				case task.KindBeta:
-					return comm.TweetBetaRelease(ctx, task.ReleaseTweet{Version: v, Announcement: ann})
-				default:
-					return "", fmt.Errorf("unknown release kind %v", r.kind)
-				}
-			}, versionPublished, announcementURL, wd.After(okayToAnnounceAndTweet))
-
-			wd.Output("Announcement URL", announcementURL)
-			wd.Output("Tweet URL", tweetURL)
+			addCommTasksForSingleRelease(wd, build, comm, r.kind, versionPublished, securitySummary, securityFixes, names)
 		}
 
 		h.RegisterDefinition(fmt.Sprintf("Go 1.%d %s", r.major, r.suffix), wd)
@@ -654,22 +631,78 @@ func createMinorReleaseWorkflow(build *BuildReleaseTasks, milestone *task.Milest
 	}
 
 	if mergeCommTasksIntoReleaseWorkflows {
-		okayToAnnounceAndTweet := wd.Action("Wait to Announce", build.ApproveAction, wd.After(v1Published, v2Published))
+		addCommTasksForDoubleMinorRelease(wd, build, comm, v1Published, v2Published, securitySummary, securityFixes, names)
+	}
 
-		// Announce that a new Go release has been published.
-		sentMail := wd.Task("mail-announcement", func(ctx *workflow.TaskContext, v1, v2 string, sec, names []string) (task.SentMail, error) {
-			return comm.AnnounceMinorRelease(ctx, task.ReleaseAnnouncement{Version: v1, SecondaryVersion: v2, Security: sec, Names: names})
-		}, v1Published, v2Published, securityFixes, names, wd.After(okayToAnnounceAndTweet))
-		announcementURL := wd.Task("await-announcement", comm.AwaitAnnounceMail, sentMail)
-		tweetURL := wd.Task("post-tweet", func(ctx *workflow.TaskContext, v1, v2, sec, ann string) (string, error) {
-			return comm.TweetMinorRelease(ctx, task.ReleaseTweet{Version: v1, SecondaryVersion: v2, Security: sec, Announcement: ann})
-		}, v1Published, v2Published, securitySummary, announcementURL, wd.After(okayToAnnounceAndTweet))
+	return wd, nil
+}
 
-		wd.Output("Announcement URL", announcementURL)
-		wd.Output("Tweet URL", tweetURL)
+func addCommTasksForDoubleMinorRelease(
+	wd *workflow.Definition, build *BuildReleaseTasks, comm task.CommunicationTasks,
+	v1Published, v2Published, securitySummary, securityFixes, names workflow.Value,
+) {
+	okayToAnnounceAndTweet := wd.Action("Wait to Announce", build.ApproveAction, wd.After(v1Published, v2Published))
+
+	// Announce that a new Go release has been published.
+	sentMail := wd.Task("mail-announcement", func(ctx *workflow.TaskContext, v1, v2 string, sec, names []string) (task.SentMail, error) {
+		return comm.AnnounceMinorRelease(ctx, task.ReleaseAnnouncement{Version: v1, SecondaryVersion: v2, Security: sec, Names: names})
+	}, v1Published, v2Published, securityFixes, names, wd.After(okayToAnnounceAndTweet))
+	announcementURL := wd.Task("await-announcement", comm.AwaitAnnounceMail, sentMail)
+	tweetURL := wd.Task("post-tweet", func(ctx *workflow.TaskContext, v1, v2, sec, ann string) (string, error) {
+		return comm.TweetMinorRelease(ctx, task.ReleaseTweet{Version: v1, SecondaryVersion: v2, Security: sec, Announcement: ann})
+	}, v1Published, v2Published, securitySummary, announcementURL, wd.After(okayToAnnounceAndTweet))
+
+	wd.Output("Announcement URL", announcementURL)
+	wd.Output("Tweet URL", tweetURL)
+}
+func addCommTasksForSingleRelease(
+	wd *workflow.Definition, build *BuildReleaseTasks, comm task.CommunicationTasks,
+	kind task.ReleaseKind, versionPublished, securitySummary, securityFixes, names workflow.Value,
+) {
+	okayToAnnounceAndTweet := wd.Action("Wait to Announce", build.ApproveAction, wd.After(versionPublished))
+
+	// Announce that a new Go release has been published.
+	var announcementURL, tweetURL workflow.Value
+	if kind == task.KindCurrentMinor || kind == task.KindPrevMinor {
+		sentMail := wd.Task("mail-announcement", func(ctx *workflow.TaskContext, v string, sec, names []string) (task.SentMail, error) {
+			return comm.AnnounceMinorRelease(ctx, task.ReleaseAnnouncement{Version: v, Security: sec, Names: names})
+		}, versionPublished, securityFixes, names, wd.After(okayToAnnounceAndTweet))
+		announcementURL = wd.Task("await-announcement", comm.AwaitAnnounceMail, sentMail)
+		tweetURL = wd.Task("post-tweet", func(ctx *workflow.TaskContext, v, sec, ann string) (string, error) {
+			return comm.TweetMinorRelease(ctx, task.ReleaseTweet{Version: v, Security: sec, Announcement: ann})
+		}, versionPublished, securitySummary, announcementURL, wd.After(okayToAnnounceAndTweet))
+	} else {
+		// TODO(dmitshur): This can be simplified on this side by deleting older things that use this API,
+		// and then merging all the Announce{Kind}Release variants into a single AnnounceRelease entrypoint.
+		sentMail := wd.Task("mail-announcement", func(ctx *workflow.TaskContext, v string, names []string) (task.SentMail, error) {
+			switch kind {
+			case task.KindMajor:
+				return comm.AnnounceMajorRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
+			case task.KindRC:
+				return comm.AnnounceRCRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
+			case task.KindBeta:
+				return comm.AnnounceBetaRelease(ctx, task.ReleaseAnnouncement{Version: v, Names: names})
+			default:
+				return task.SentMail{}, fmt.Errorf("unknown release kind %v", kind)
+			}
+		}, versionPublished, names, wd.After(okayToAnnounceAndTweet))
+		announcementURL = wd.Task("await-announcement", comm.AwaitAnnounceMail, sentMail)
+		tweetURL = wd.Task("post-tweet", func(ctx *workflow.TaskContext, v, ann string) (string, error) {
+			switch kind {
+			case task.KindMajor:
+				return comm.TweetMajorRelease(ctx, task.ReleaseTweet{Version: v})
+			case task.KindRC:
+				return comm.TweetRCRelease(ctx, task.ReleaseTweet{Version: v, Announcement: ann})
+			case task.KindBeta:
+				return comm.TweetBetaRelease(ctx, task.ReleaseTweet{Version: v, Announcement: ann})
+			default:
+				return "", fmt.Errorf("unknown release kind %v", kind)
+			}
+		}, versionPublished, announcementURL, wd.After(okayToAnnounceAndTweet))
 	}
 
-	return wd, nil
+	wd.Output("Announcement URL", announcementURL)
+	wd.Output("Tweet URL", tweetURL)
 }
 
 func addSingleReleaseWorkflow(

internal/task/announce.go

@@ -39,7 +39,8 @@ type ReleaseAnnouncement struct {
 	// 	• "go1.18beta1" or "go1.18rc1" for a pre-release
 	Version string
 	// SecondaryVersion is an older Go version that was also released.
-	// This only applies to minor releases. For example, "go1.16.10".
+	// This only applies to minor releases when two releases are made.
+	// For example, "go1.16.10".
 	SecondaryVersion string
 
 	// Security is a list of descriptions, one for each distinct
@@ -77,7 +78,9 @@ type SentMail struct {
 
 // AnnounceMinorRelease sends an email announcing a minor Go release to Google Groups.
 func (t AnnounceMailTasks) AnnounceMinorRelease(ctx *workflow.TaskContext, r ReleaseAnnouncement) (SentMail, error) {
-	if err := verifyGoVersions(r.Version, r.SecondaryVersion); err != nil {
+	if err := verifyGoVersions(r.Version); err != nil {
+		return SentMail{}, err
+	} else if err := verifyGoVersions(r.SecondaryVersion); r.SecondaryVersion != "" && err != nil {
 		return SentMail{}, err
 	}
 

internal/task/announce_test.go

@@ -80,6 +80,15 @@ This is CVE-2022-27536 and https://go.dev/issue/51759.`,
 			},
 			wantSubject: "[security] Go 1.18.1 and Go 1.17.9 are released",
 		},
+		{
+			name: "minor-solo",
+			in: ReleaseAnnouncement{
+				Version:  "go1.11.1",
+				Security: []string{"abc: security fix 1", "xyz: security fix 2"},
+				Names:    []string{"Alice"},
+			},
+			wantSubject: "[security] Go 1.11.1 is released",
+		},
 		{
 			name: "beta",
 			in: ReleaseAnnouncement{

internal/task/template/announce-minor.md

@@ -1,12 +1,19 @@
 Subject: {{subjectPrefix .}}
-	Go {{short .Version}} and Go {{short .SecondaryVersion}} are released
+	Go {{short .Version}} {{with .SecondaryVersion}}and Go {{. | short}} are{{else}}is{{end}} released
 
 Hello gophers,
 
+{{if .SecondaryVersion -}}
 We have just released Go versions {{short .Version}} and {{short .SecondaryVersion}}, minor point releases.
-
-{{with .Security}}These minor releases include {{len .}} security fixes following the [security policy](https://go.dev/security):
-{{range .}}
+{{- else -}}
+We have just released Go version {{short .Version}}, a minor point release.
+{{- end}}
+
+{{if .Security}}{{if .SecondaryVersion -}}
+These minor releases include
+{{- else -}}
+This minor release includes{{end}} {{len .Security}} security fixes following the [security policy](https://go.dev/security):
+{{range .Security}}
 -{{indent .}}
 {{end}}
 {{end -}}
@@ -20,7 +27,7 @@ https://go.dev/dl/
 To compile from source using a Git clone, update to the release with
 `git checkout {{.Version}}` and build as usual.
 
-Thanks to everyone who contributed to the releases.
+Thanks to everyone who contributed to the release{{if .SecondaryVersion}}s{{end}}.
 
 Cheers,
 {{with .Names}}{{join .}} for the{{else}}The{{end}} Go team

internal/task/testdata/announce-minor-solo.html

@@ -0,0 +1,20 @@
+<p>Hello gophers,</p>
+<p>We have just released Go version 1.11.1, a minor point release.</p>
+<p>This minor release includes 2 security fixes following the <a href="https://go.dev/security">security policy</a>:</p>
+<ul>
+<li>
+<p>abc: security fix 1</p>
+</li>
+<li>
+<p>xyz: security fix 2</p>
+</li>
+</ul>
+<p>View the release notes for more information:<br>
+<a href="https://go.dev/doc/devel/release#go1.11.1">https://go.dev/doc/devel/release#go1.11.1</a></p>
+<p>You can download binary and source distributions from the Go website:<br>
+<a href="https://go.dev/dl/">https://go.dev/dl/</a></p>
+<p>To compile from source using a Git clone, update to the release with<br>
+<code>git checkout go1.11.1</code> and build as usual.</p>
+<p>Thanks to everyone who contributed to the release.</p>
+<p>Cheers,<br>
+Alice for the Go team</p>

internal/task/testdata/announce-minor-solo.txt

@@ -0,0 +1,23 @@
+Hello gophers,
+
+We have just released Go version 1.11.1, a minor point release.
+
+This minor release includes 2 security fixes following the security policy <https://go.dev/security>:
+
+-	abc: security fix 1
+
+-	xyz: security fix 2
+
+View the release notes for more information:
+https://go.dev/doc/devel/release#go1.11.1
+
+You can download binary and source distributions from the Go website:
+https://go.dev/dl/
+
+To compile from source using a Git clone, update to the release with
+git checkout go1.11.1 and build as usual.
+
+Thanks to everyone who contributed to the release.
+
+Cheers,
+Alice for the Go team

internal/task/tweet.go

@@ -43,7 +43,8 @@ type ReleaseTweet struct {
 	// 	• "go1.18beta1" or "go1.18rc1" for a pre-release
 	Version string
 	// SecondaryVersion is an older Go version that was also released.
-	// This only applies to minor releases. For example, "go1.16.10".
+	// This only applies to minor releases when two releases are made.
+	// For example, "go1.16.10".
 	SecondaryVersion string
 
 	// Security is an optional sentence describing security fixes
@@ -93,7 +94,9 @@ type TweetTasks struct {
 // TweetMinorRelease posts a tweet announcing a minor Go release.
 // ErrTweetTooLong is returned if the inputs result in a tweet that's too long.
 func (t TweetTasks) TweetMinorRelease(ctx *workflow.TaskContext, r ReleaseTweet) (tweetURL string, _ error) {
-	if err := verifyGoVersions(r.Version, r.SecondaryVersion); err != nil {
+	if err := verifyGoVersions(r.Version); err != nil {
+		return "", err
+	} else if err := verifyGoVersions(r.SecondaryVersion); r.SecondaryVersion != "" && err != nil {
 		return "", err
 	}
 	if !strings.HasPrefix(r.Announcement, announcementPrefix) {
@@ -241,7 +244,7 @@ func tweetText(r ReleaseTweet, rnd *rand.Rand) (string, error) {
 			ReleaseTweet
 		}{
 			Curr:         r.Version[len("go"):],
-			Prev:         r.SecondaryVersion[len("go"):],
+			Prev:         strings.TrimPrefix(r.SecondaryVersion, "go"),
 			ReleaseTweet: r,
 		}
 	} else {
@@ -256,7 +259,7 @@ func tweetText(r ReleaseTweet, rnd *rand.Rand) (string, error) {
 }
 
 const tweetTextTmpl = `{{define "minor" -}}
-{{emoji "release"}} Go {{.Curr}} and {{.Prev}} are released!
+{{emoji "release"}} Go {{.Curr}} {{with .Prev}}and {{.}} are{{else}}is{{end}} released!
 
 {{with .Security}}{{emoji "security"}} Security: {{.}}{{"\n\n"}}{{end -}}
 
@@ -441,7 +444,7 @@ func fetchRandomArchive(goVer string, rnd *rand.Rand) (archive golangorgDLFile,
 func fetchReleaseArchives(goVer string) (archives []golangorgDLFile, _ error) {
 	url := "https://go.dev/dl/?mode=json"
 	if strings.Contains(goVer, "beta") || strings.Contains(goVer, "rc") ||
-		goVer == "go1.17" || goVer == "go1.17.1" /* For TestTweetRelease. */ {
+		goVer == "go1.17" || goVer == "go1.17.1" || goVer == "go1.11.1" /* For TestTweetRelease. */ {
 
 		url += "&include=all"
 	}

internal/task/tweet_test.go

@@ -65,6 +65,33 @@ Unpacking go1.17.1.linux-arm64.tar.gz ...
 Success. You may now run 'go1.17.1'
 $ go1.17.1 version
 go version go1.17.1 linux/arm64` + "\n",
+		},
+		{
+			name:   "minor-solo",
+			taskFn: TweetTasks.TweetMinorRelease,
+			in: ReleaseTweet{
+				Version:      "go1.11.1",
+				Announcement: "https://groups.google.com/g/golang-announce/c/pFXKAfoVJqw",
+				RandomSeed:   23,
+			},
+			wantLog: `tweet text:
+🎆 Go 1.11.1 is released!
+
+📣 Announcement: https://groups.google.com/g/golang-announce/c/pFXKAfoVJqw
+
+📦 Download: https://go.dev/dl/#go1.11.1
+
+#golang
+tweet image:
+$ go install golang.org/dl/go1.11.1@latest
+$ go1.11.1 download
+Downloaded   0.0% (        0 / 124181190 bytes) ...
+Downloaded  50.0% ( 62090595 / 124181190 bytes) ...
+Downloaded 100.0% (124181190 / 124181190 bytes)
+Unpacking go1.11.1.darwin-amd64.tar.gz ...
+Success. You may now run 'go1.11.1'
+$ go1.11.1 version
+go version go1.11.1 darwin/amd64` + "\n",
 		},
 		{
 			name:   "beta",