change release note generation

Diaphteiros · Diaphteiros · commit d726e0c56130 · 2025-10-30T16:59:05.000+01:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -12,7 +12,7 @@ Fixes #
 
 Format of block header: <category> <target_group>
 Possible values:
-- category:       breaking|feature|bugfix|doc|other
+- category:       breaking|feature|bugfix|refactor|doc|chore|other
 - target_group:   user|operator|developer|dependency
 -->
 ```feature user
diff --git a/changelog/main.go b/changelog/main.go
@@ -0,0 +1,285 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"regexp"
+	"slices"
+	"strings"
+)
+
+const (
+	releaseNotePattern = "```" + `(?<type>[a-zA-z]+)(\((?<subtype>[a-zA-Z]+)\))?\s*(?<audience>[a-zA-Z]+)\s*(\r)?\n(?<body>.*)\n` + "```"
+
+	SectionKeyOther    = "other"
+	SubsectionKeyOther = "other"
+)
+
+var (
+	releaseNoteRegex = regexp.MustCompile(releaseNotePattern)
+)
+
+func main() {
+	if len(os.Args) != 2 {
+		panic("expected exactly one argument: path to PR info JSON file")
+	}
+
+	data, err := os.ReadFile(os.Args[1])
+	if err != nil {
+		panic(fmt.Sprintf("failed to read PR info file: %v", err))
+	}
+	prs := []PRInfo{}
+	if err := json.Unmarshal(data, &prs); err != nil {
+		panic(fmt.Errorf("failed to unmarshal PR info JSON: %w", err))
+	}
+
+	sections := NewSections().
+		WithSection("breaking", "🚨 Breaking", nil).
+		WithSection("feature", "🚀 Features", nil).
+		WithSection("bugfix", "🐛 Bugfixes", nil).
+		WithSection("refactor", "🛠️ Refactorings", nil).
+		WithSection("doc", "📚 Documentation", nil).
+		WithSection("chore", "🔧 Chores", nil)
+
+	for _, pr := range prs {
+		prNotes := pr.ExtractReleaseNotes()
+		for _, note := range prNotes {
+			sections.Add(note)
+		}
+	}
+
+	fmt.Print(sections.Render())
+}
+
+type PRInfo struct {
+	Number int      `json:"number"`
+	Title  string   `json:"title"`
+	Body   string   `json:"body"`
+	URL    string   `json:"url"`
+	Author PRAuthor `json:"author"`
+}
+
+type PRAuthor struct {
+	ID    string `json:"id"`
+	Name  string `json:"name"`
+	Login string `json:"login"`
+	IsBot bool   `json:"is_bot"`
+}
+
+type Sections struct {
+	CustomSections map[string]*Section
+	Other          *Section
+	IterationOrder []string
+}
+
+type Section struct {
+	ID          string
+	Title       string
+	Notes       []ReleaseNote
+	Subsections *Subsections
+}
+
+type Subsections struct {
+	CustomSubsections map[string]*Subsection
+	Other             *Subsection
+}
+
+type Subsection struct {
+	ID    string
+	Title string
+	Notes []ReleaseNote
+}
+
+type ReleaseNote struct {
+	PRInfo   *PRInfo
+	Note     string
+	Type     string
+	Subtype  string
+	Audience string
+}
+
+func NewSections() *Sections {
+	ss := &Sections{
+		CustomSections: map[string]*Section{},
+		Other:          NewSection(SectionKeyOther, "➕ Other", nil),
+		IterationOrder: []string{},
+	}
+	return ss
+}
+
+func (ss *Sections) WithSection(id, title string, subsections map[string]string) *Sections {
+	section := NewSection(id, title, subsections)
+	ss.CustomSections[id] = section
+	ss.IterationOrder = append(ss.IterationOrder, id)
+	return ss
+}
+
+func NewSection(id, title string, subsections map[string]string) *Section {
+	section := &Section{
+		ID:          id,
+		Title:       title,
+		Notes:       []ReleaseNote{},
+		Subsections: NewSubsections(subsections),
+	}
+	return section
+}
+
+func NewSubsections(subsections map[string]string) *Subsections {
+	ss := &Subsections{
+		CustomSubsections: map[string]*Subsection{},
+		Other:             NewSubsection(SubsectionKeyOther, "➕ Other"),
+	}
+	for key, title := range subsections {
+		ss.CustomSubsections[key] = NewSubsection(key, title)
+	}
+	return ss
+}
+
+func NewSubsection(id, title string) *Subsection {
+	return &Subsection{
+		ID:    id,
+		Title: title,
+		Notes: []ReleaseNote{},
+	}
+}
+
+func (ss Sections) Add(note ReleaseNote) {
+	section, ok := ss.CustomSections[note.Type]
+	if !ok {
+		section = ss.Other
+	}
+	var subsection *Subsection
+	if note.Subtype != "" {
+		subsection, ok = section.Subsections.CustomSubsections[note.Subtype]
+		if !ok {
+			subsection = section.Subsections.Other
+		}
+		subsection.Notes = append(subsection.Notes, note)
+	} else {
+		section.Notes = append(section.Notes, note)
+	}
+}
+
+func (pri *PRInfo) ExtractReleaseNotes() []ReleaseNote {
+	res := []ReleaseNote{}
+	matches := releaseNoteRegex.FindAllStringSubmatch(pri.Body, -1)
+	for _, match := range matches {
+		note := ReleaseNote{
+			PRInfo:   pri,
+			Note:     normalizeLineEndings(match[releaseNoteRegex.SubexpIndex("body")]),
+			Type:     strings.ToLower(match[releaseNoteRegex.SubexpIndex("type")]),
+			Subtype:  strings.ToLower(match[releaseNoteRegex.SubexpIndex("subtype")]),
+			Audience: strings.ToLower(match[releaseNoteRegex.SubexpIndex("audience")]),
+		}
+		if note.Note == "" || (len(note.Note) <= 6 && strings.ToUpper(strings.TrimSpace(note.Note)) == "NONE") {
+			continue
+		}
+		res = append(res, note)
+	}
+	return res
+}
+
+func (ss *Sections) Render() string {
+	var sb strings.Builder
+	sb.WriteString("# Changelog\n\n\n")
+	for _, sid := range ss.IterationOrder {
+		section := ss.CustomSections[sid]
+		sb.WriteString(section.Render())
+	}
+	sb.WriteString(ss.Other.Render())
+	sb.WriteString("\n")
+	return sb.String()
+}
+
+func (s *Section) Render() string {
+	var sb strings.Builder
+	if len(s.Notes) == 0 && !s.Subsections.HasNotes() {
+		return ""
+	}
+	sb.WriteString(fmt.Sprintf("## %s\n\n", s.Title))
+	notesByAudience, audienceOrder := orderNotesByAudience(s.Notes)
+	for _, audience := range audienceOrder {
+		notes := notesByAudience[audience]
+		sb.WriteString(fmt.Sprintf("#### [%s]\n", strings.ToUpper(audience)))
+		for _, note := range notes {
+			author := "@" + note.PRInfo.Author.Login
+			if note.PRInfo.Author.IsBot {
+				author = "⚙️"
+			}
+			sb.WriteString(fmt.Sprintf("- %s **(#%d, %s)**\n", indent(strings.TrimSpace(note.Note), 2), note.PRInfo.Number, author))
+		}
+	}
+	sb.WriteString("\n")
+
+	for _, subsection := range s.Subsections.CustomSubsections {
+		sb.WriteString(subsection.Render())
+	}
+	sb.WriteString(s.Subsections.Other.Render())
+	return sb.String()
+}
+
+func (ss *Subsections) HasNotes() bool {
+	if ss == nil {
+		return false
+	}
+	if len(ss.Other.Notes) > 0 {
+		return true
+	}
+	for _, subsection := range ss.CustomSubsections {
+		if len(subsection.Notes) > 0 {
+			return true
+		}
+	}
+	return false
+}
+
+func (s *Subsection) Render() string {
+	var sb strings.Builder
+	if len(s.Notes) == 0 {
+		return ""
+	}
+	sb.WriteString(fmt.Sprintf("### %s\n\n", s.Title))
+	notesByAudience, audienceOrder := orderNotesByAudience(s.Notes)
+	for _, audience := range audienceOrder {
+		notes := notesByAudience[audience]
+		sb.WriteString(fmt.Sprintf("#### [%s]\n", strings.ToUpper(audience)))
+		for _, note := range notes {
+			author := "@" + note.PRInfo.Author.Login
+			if note.PRInfo.Author.IsBot {
+				author = "⚙️"
+			}
+			sb.WriteString(fmt.Sprintf("- %s **(#%d, %s)**\n", indent(strings.TrimSpace(note.Note), 2), note.PRInfo.Number, author))
+		}
+	}
+	sb.WriteString("\n")
+	return sb.String()
+}
+
+func normalizeLineEndings(s string) string {
+	return strings.ReplaceAll(s, "\r\n", "\n")
+}
+
+func indent(s string, spaces int) string {
+	prefix := strings.Repeat(" ", spaces)
+	lines := strings.Split(s, "\n")
+	for i, line := range lines {
+		lines[i] = prefix + line
+	}
+	return strings.Join(lines, "\n")
+}
+
+// orderNotesByAudience returns a mapping from audience to list of release notes for that audience
+// and an alphabetically ordered list of audiences.
+func orderNotesByAudience(notes []ReleaseNote) (map[string][]ReleaseNote, []string) {
+	notesByAudience := map[string][]ReleaseNote{}
+	for _, note := range notes {
+		notesByAudience[note.Audience] = append(notesByAudience[note.Audience], note)
+	}
+	audiences := []string{}
+	for audience := range notesByAudience {
+		audiences = append(audiences, audience)
+	}
+	slices.Sort(audiences)
+	return notesByAudience, audiences
+}
diff --git a/generate-changelog.sh b/generate-changelog.sh
