break into component sections as needed

Author: colleenmcginnis

internal/assets/markdown-breaking-template.md.tmpl

@@ -1,7 +1,8 @@
 ## {{.Version}} [{{.Repo}}-{{.Version}}-breaking-changes]
-{{ if .BreakingChange -}}{{ range $k, $v := .BreakingChange }}{{ range $item := $v }}
+{{ if .BreakingChange -}}{{ range $k, $v := .BreakingChange }}{{ $k | header2 }}{{ range $item := $v }}
+
 ::::{dropdown} {{ $item.Summary | beautify }}
-{{ if $item.Description }}{{ $item.Description }}{{ end }}
+{{ if $item.Description }}{{ $item.Description }}{{ else }}% Describe the functionality that changed{{ end }}
 
 For more information, check {{ linkPRSource $item.Component $item.LinkedPR }}{{ linkIssueSource $item.Component $item.LinkedIssue }}.
 

internal/assets/markdown-deprecations-template.md.tmpl

@@ -1,8 +1,8 @@
 ## {{.Version}} [{{.Repo}}-{{.Version}}-deprecations]
-{{ if .Deprecation -}}{{ range $k, $v := .Deprecation }}{{ range $item := $v }}
+{{ if .Deprecation -}}{{ range $k, $v := .Deprecation }}{{ $k | header2 }}{{ range $item := $v }}
 
 ::::{dropdown} {{ $item.Summary | beautify }}
-{{ if $item.Description }}{{ $item.Description }}{{ end }}
+{{ if $item.Description }}{{ $item.Description }}{{ else }}% Describe the functionality that was deprecated{{ end }}
 
 For more information, check {{ linkPRSource $item.Component $item.LinkedPR }}{{ linkIssueSource $item.Component $item.LinkedIssue }}.
 

internal/assets/markdown-index-template.md.tmpl

@@ -1,30 +1,24 @@
 ## {{.Version}} [{{.Repo}}-release-notes-{{.Version}}]
 {{ if or .KnownIssue .BreakingChange .Deprecation }}
 {{ other_links }}{{- end }}
-{{ if or .Feature .Enhancement .Security .BugFix }}{{ if or .Feature .Enhancement }}
+{{ if or .Feature .Enhancement .Security .BugFix }}
+{{ if or .Feature .Enhancement }}
 ### Features and enhancements [{{.Repo}}-{{.Version}}-features-enhancements]
-{{ if .Feature }}{{ range $k, $v := .Feature }}{{ range $item := $v }}
-* {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}{{ if $item.Description }}
-{{ $item.Description | indent }}
-{{- end }}
-{{- end }}{{- end }}{{- end }}{{ if .Enhancement }}{{ range $k, $v := .Enhancement }}{{ range $item := $v }}
+{{ $additions := combine .Feature .Enhancement }}{{ range $k, $v := $additions }}{{ header2 $k }}
+{{ range $item := $v }}
 * {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}{{ if $item.Description }}
 {{ $item.Description | indent }}
 {{- end }}
 {{- end }}{{- end }}{{- end }}
-{{- end }}
 
 {{ if or .Security .BugFix }}
 ### Fixes [{{.Repo}}-{{.Version}}-fixes]
-{{ if .Security }}{{ range $k, $v := .Security }}{{ range $item := $v }}
+{{ $fixes := combine .Security .BugFix }}{{ range $k, $v := $fixes }}{{ header2 $k }}
+{{ range $item := $v }}
 * {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}{{ if $item.Description }}
 {{ $item.Description | indent }}
 {{- end }}
-{{- end }}{{- end }}{{- end }}{{ if .BugFix }}{{ range $k, $v := .BugFix }}{{ range $item := $v }}
-* {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}{{ if $item.Description }}
-{{ $item.Description | indent }}
-{{- end }}
-{{- end }}{{- end }}{{- end }}{{- end }}
+{{- end }}{{- end }}{{- end }}
 {{ else }}
 _No new features, enhancements, or fixes._
 {{- end }}

internal/changelog/renderer.go

@@ -159,15 +159,35 @@ func (r Renderer) Render() error {
 				if len(links) > 0 {
 					return fmt.Sprintf(
 						"_This release also includes: %s._",
-						strings.Join(links, " and"),
+						strings.Join(links, " and "),
 					)
 				} else {
 					return ""
 				}
 			},
 			// Ensure components have section styling
-			"header2": func(s1 string) string {
-				return fmt.Sprintf("**%s**", s1)
+			"header2": func(s string) string {
+				if s == "" || s == r.repo {
+					return ""
+				}
+				s = strings.ToUpper(string(s[0])) + s[1:]
+				s = strings.ReplaceAll(s, "-", " ")
+				return fmt.Sprintf("\n\n**%s**", s)
+			},
+			"combine": func(map1 map[string][]Entry, map2 map[string][]Entry) map[string][]Entry {
+				combinedMap := make(map[string][]Entry)
+
+				// Start with a copy of map1 entries
+				for k, v := range map1 {
+					combinedMap[k] = append([]Entry{}, v...)
+				}
+
+				// Merge entries from map2, appending to any existing entries
+				for k, v := range map2 {
+					combinedMap[k] = append(combinedMap[k], v...)
+				}
+
+				return combinedMap
 			},
 		}).
 		Parse(string(tpl))