Release notes generation

.github/pull_request_template.md

@@ -1,4 +1,5 @@
 <!--
+  Thank you for your contribution to the Vitess project.
   How to contribute: https://vitess.io/docs/contributing/
   Please first make sure there is an open Issue to discuss the feature/fix suggested in this PR.
   If this is a new feature, please mark the Issue as "RFC".
@@ -8,25 +9,15 @@
 
 ## Description
 <!-- A few sentences describing the overall goals of the pull request's commits. -->
+<!-- If this is a bug fix and you think the fix should be backported, please write so. -->
 
 ## Related Issue(s)
-<!-- List related issues and pull requests: -->
+<!-- List related issues and pull requests. If this PR fixes an issue, please add it using Fixes #????  -->
 
-- 
 
 ## Checklist
-- [ ] Should this PR be backported?
 - [ ] Tests were added or are not required
 - [ ] Documentation was added or is not required
 
 ## Deployment Notes
-<!-- Notes regarding deployment of the contained body of work. These should note any db migrations, etc. -->
-
-## Impacted Areas in Vitess
-Components that this PR will affect:
-
-- [ ]  Query Serving
-- [ ]  VReplication
-- [ ]  Cluster Management
-- [ ]  Build/CI
-- [ ]  VTAdmin
+<!-- Notes regarding deployment of the contained body of work. These should note any db migrations, etc. -->

Makefile

@@ -418,3 +418,6 @@ vtadmin_web_proto_types: vtadmin_web_install
 # is changed by adding a new test to an existing shard. Any new or modified files need to be committed into git
 generate_ci_workflows:
 	cd test && go run ci_workflow_gen.go && cd ..
+
+release-notes:
+	go run ./go/tools/release-notes -from $(FROM) -to $(TO)

go/tools/release-notes/release_notes.go

@@ -0,0 +1,271 @@
+/*
+Copyright 2021 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 main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"log"
+	"os"
+	"os/exec"
+	"regexp"
+	"sort"
+	"strings"
+	"sync"
+	"text/template"
+)
+
+type (
+	label struct {
+		Name string `json:"name"`
+	}
+
+	prInfo struct {
+		Labels []label `json:"labels"`
+		Number int     `json:"number"`
+		Title  string  `json:"title"`
+	}
+
+	prsByComponent = map[string][]prInfo
+
+	prsByType = map[string]prsByComponent
+
+	sortedPRComponent struct {
+		Name    string
+		PrInfos []prInfo
+	}
+
+	sortedPRType struct {
+		Name       string
+		Components []sortedPRComponent
+	}
+)
+
+const (
+	markdownTemplate = `
+{{- range $type := . }}
+## {{ $type.Name }}
+{{- range $component := $type.Components }} 
+### {{ $component.Name }}
+{{- range $prInfo := $component.PrInfos }}
+ - {{ $prInfo.Title }} #{{ $prInfo.Number }}
+{{- end }}
+{{- end }}
+{{- end }}
+`
+
+	prefixType      = "Type: "
+	prefixComponent = "Component: "
+)
+
+func loadMergedPRs(from, to string) ([]string, error) {
+	cmd := exec.Command("git", "log", "--oneline", fmt.Sprintf("%s..%s", from, to))
+	out, err := cmd.Output()
+	if err != nil {
+		execErr := err.(*exec.ExitError)
+		return nil, fmt.Errorf("%s:\nstderr: %s\nstdout: %s", err.Error(), execErr.Stderr, out)
+	}
+
+	var prs []string
+	rgx := regexp.MustCompile(`Merge pull request #(\d+)`)
+	lines := strings.Split(string(out), "\n")
+	for _, line := range lines {
+		lineInfo := rgx.FindStringSubmatch(line)
+		if len(lineInfo) == 2 {
+			prs = append(prs, lineInfo[1])
+		}
+	}
+
+	sort.Strings(prs)
+	return prs, nil
+}
+
+func loadPRinfo(pr string) (prInfo, error) {
+	cmd := exec.Command("gh", "pr", "view", pr, "--json", "title,number,labels")
+	out, err := cmd.Output()
+	if err != nil {
+		execErr, ok := err.(*exec.ExitError)
+		if ok {
+			return prInfo{}, fmt.Errorf("%s:\nstderr: %s\nstdout: %s", err.Error(), execErr.Stderr, out)
+		}
+		if strings.Contains(err.Error(), " executable file not found in") {
+			return prInfo{}, fmt.Errorf("the command `gh` seems to be missing. Please install it from https://github.com/cli/cli")
+		}
+		return prInfo{}, err
+	}
+	var prInfo prInfo
+	err = json.Unmarshal(out, &prInfo)
+	return prInfo, err
+}
+
+func loadAllPRs(prs []string) ([]prInfo, error) {
+	errChan := make(chan error)
+	wgDone := make(chan bool)
+	prChan := make(chan string, len(prs))
+	// fill the work queue
+	for _, s := range prs {
+		prChan <- s
+	}
+	close(prChan)
+
+	var prInfos []prInfo
+	fmt.Printf("Found %d merged PRs. Loading PR info", len(prs))
+	wg := sync.WaitGroup{}
+	mu := sync.Mutex{}
+	for i := 0; i < 10; i++ {
+		wg.Add(1)
+		go func() {
+			// load meta data about PRs
+			defer wg.Done()
+			for b := range prChan {
+				fmt.Print(".")
+				prInfo, err := loadPRinfo(b)
+				if err != nil {
+					errChan <- err
+					break
+				}
+				mu.Lock()
+				prInfos = append(prInfos, prInfo)
+				mu.Unlock()
+			}
+		}()
+	}
+
+	go func() {
+		// wait for the loading to finish
+		wg.Wait()
+		close(wgDone)
+	}()
+
+	var err error
+	select {
+	case <-wgDone:
+		break
+	case err = <-errChan:
+		break
+	}
+
+	fmt.Println()
+	return prInfos, err
+}
+
+func groupPRs(prInfos []prInfo) prsByType {
+	prPerType := prsByType{}
+
+	for _, info := range prInfos {
+		var typ, component string
+		for _, lbl := range info.Labels {
+			switch {
+			case strings.HasPrefix(lbl.Name, prefixType):
+				typ = strings.TrimPrefix(lbl.Name, prefixType)
+			case strings.HasPrefix(lbl.Name, prefixComponent):
+				component = strings.TrimPrefix(lbl.Name, prefixComponent)
+			}
+		}
+		switch typ {
+		case "":
+			typ = "Other"
+		case "Bug":
+			typ = "Bug fixes"
+		}
+
+		if component == "" {
+			component = "Other"
+		}
+		components, exists := prPerType[typ]
+		if !exists {
+			components = prsByComponent{}
+			prPerType[typ] = components
+		}
+
+		prsPerComponentAndType := components[component]
+		components[component] = append(prsPerComponentAndType, info)
+	}
+	return prPerType
+}
+
+func createSortedPrTypeSlice(prPerType prsByType) []sortedPRType {
+	var data []sortedPRType
+	for typeKey, typeElem := range prPerType {
+		newPrType := sortedPRType{
+			Name: typeKey,
+		}
+		for componentKey, prInfos := range typeElem {
+			newComponent := sortedPRComponent{
+				Name:    componentKey,
+				PrInfos: prInfos,
+			}
+			sort.Slice(newComponent.PrInfos, func(i, j int) bool {
+				return newComponent.PrInfos[i].Number < newComponent.PrInfos[j].Number
+			})
+			newPrType.Components = append(newPrType.Components, newComponent)
+		}
+		sort.Slice(newPrType.Components, func(i, j int) bool {
+			return newPrType.Components[i].Name < newPrType.Components[j].Name
+		})
+		data = append(data, newPrType)
+	}
+	sort.Slice(data, func(i, j int) bool {
+		return data[i].Name < data[j].Name
+	})
+	return data
+}
+
+func writePrInfos(fileout string, prPerType prsByType) (err error) {
+	writeTo := os.Stdout
+	if fileout != "" {
+		writeTo, err = os.OpenFile(fileout, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0666)
+		if err != nil {
+			return err
+		}
+	}
+
+	data := createSortedPrTypeSlice(prPerType)
+
+	t := template.Must(template.New("markdownTemplate").Parse(markdownTemplate))
+	err = t.ExecuteTemplate(writeTo, "markdownTemplate", data)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func main() {
+	from := flag.String("from", "", "from sha/tag/branch")
+	to := flag.String("to", "HEAD", "to sha/tag/branch")
+	fileout := flag.String("file", "", "file on which to write release notes, stdout if empty")
+
+	flag.Parse()
+
+	prs, err := loadMergedPRs(*from, *to)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	prInfos, err := loadAllPRs(prs)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	prPerType := groupPRs(prInfos)
+
+	err = writePrInfos(*fileout, prPerType)
+	if err != nil {
+		log.Fatal(err)
+	}
+}

go/tools/release-notes/release_notes_test.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2021 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 main
+
+import (
+	"testing"
+
+	"vitess.io/vitess/go/test/utils"
+)
+
+func Test_groupPRs(t *testing.T) {
+	tests := []struct {
+		name    string
+		prInfos []prInfo
+		want    map[string]map[string][]prInfo
+	}{
+		{
+			name:    "Single PR info with no labels",
+			prInfos: []prInfo{{Title: "pr 1", Number: 1}},
+			want:    map[string]map[string][]prInfo{"Other": {"Other": []prInfo{{Title: "pr 1", Number: 1}}}},
+		}, {
+			name:    "Single PR info with type label",
+			prInfos: []prInfo{{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}}}},
+			want:    map[string]map[string][]prInfo{"Bug fixes": {"Other": []prInfo{{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}}}}}}},
+		{
+			name:    "Single PR info with type and component labels",
+			prInfos: []prInfo{{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}, {Name: prefixComponent + "VTGate"}}}},
+			want:    map[string]map[string][]prInfo{"Bug fixes": {"VTGate": []prInfo{{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}, {Name: prefixComponent + "VTGate"}}}}}}},
+		{
+			name: "Multiple PR infos with type and component labels", prInfos: []prInfo{
+				{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}, {Name: prefixComponent + "VTGate"}}},
+				{Title: "pr 2", Number: 2, Labels: []label{{Name: prefixType + "Feature"}, {Name: prefixComponent + "VTTablet"}}}},
+			want: map[string]map[string][]prInfo{"Bug fixes": {"VTGate": []prInfo{{Title: "pr 1", Number: 1, Labels: []label{{Name: prefixType + "Bug"}, {Name: prefixComponent + "VTGate"}}}}}, "Feature": {"VTTablet": []prInfo{{Title: "pr 2", Number: 2, Labels: []label{{Name: prefixType + "Feature"}, {Name: prefixComponent + "VTTablet"}}}}}}},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := groupPRs(tt.prInfos)
+			utils.MustMatch(t, tt.want, got)
+		})
+	}
+}