refine formatting

Author: colleenmcginnis

internal/assets/markdown-breaking-template.md

@@ -1,5 +1,4 @@
 ## {{.Version}} [{{.Repo}}-{{.Version}}-breaking-changes]
-
 {{ if .BreakingChange -}}{{ range $k, $v := .BreakingChange }}{{ range $item := $v }}
 ::::{dropdown} {{ $item.Summary | beautify }}
 {{ if $item.Description }}{{ $item.Description }}{{ end }}
@@ -10,4 +9,6 @@ For more information, check {{ linkPRSource $item.Component $item.LinkedPR }}{{
 
 {{ if not $item.Action }}% {{ end }}**Action**<br>{{ if $item.Action }}{{ $item.Action }}{{ else }}_Add a description of the what action to take_{{ end }}
 ::::
-{{- end }}{{- end }}{{- end }}
+{{- end }}{{- end }}{{ else }}
+_No breaking changes._
+{{- end }}

internal/assets/markdown-deprecations-template.md

@@ -11,5 +11,6 @@ For more information, check {{ linkPRSource $item.Component $item.LinkedPR }}{{
 {{ if not $item.Action }}% {{ end }}**Action**<br>{{ if $item.Action }}{{ $item.Action }}{{ else }}_Add a description of the what action to take_{{ end }}
 ::::
 {{- end }}{{- end }}
-{{ else }}_No deprecations._
+{{ else }}
+_No deprecations._
 {{- end }}

internal/assets/markdown-index-template.md

@@ -1,19 +1,29 @@
 ## {{.Version}} [{{.Repo}}-release-notes-{{.Version}}]
-
+{{ 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 }}
+* {{ $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 }}
-* {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}
+* {{ $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 }}
-* {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}
+* {{ $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 }}
-{{- end }}{{- end }}{{- end }}
+* {{ $item.Summary | beautify }} {{ linkPRSource $item.Component $item.LinkedPR }} {{ linkIssueSource $item.Component $item.LinkedIssue }}{{ if $item.Description }}
+{{ $item.Description | indent }}
+{{- end }}
+{{- end }}{{- end }}{{- end }}{{- end }}
+{{ else }}
+_No new features, enhancements, or fixes._
 {{- end }}

internal/changelog/fragment/fragment.go

@@ -11,4 +11,7 @@ type Fragment struct {
 	Component   string `yaml:"component"`
 	Pr          string `yaml:"pr"`
 	Issue       string `yaml:"issue"`
+	Impact      string `yaml:"impact"`
+	Action      string `yaml:"action"`
+	Workaround  string `yaml:"workaround"`
 }

internal/changelog/renderer.go

@@ -53,19 +53,27 @@ func (r Renderer) Render() error {
 		Changelog Changelog
 		Kinds     map[Kind]bool
 
+		// In Markdown, this goes to release notes
+		Enhancement map[string][]Entry
+		Feature     map[string][]Entry
+		Security    map[string][]Entry
+		BugFix      map[string][]Entry
+		// In Markdown, this goes to breaking changes
 		BreakingChange map[string][]Entry
-		Deprecation    map[string][]Entry
-		BugFix         map[string][]Entry
-		Enhancement    map[string][]Entry
-		Feature        map[string][]Entry
-		KnownIssue     map[string][]Entry
-		Security       map[string][]Entry
-		Upgrade        map[string][]Entry
-		Other          map[string][]Entry
+		// In Markdown, this goes to deprecations
+		Deprecation map[string][]Entry
+		// In Markdown, this goes to known issues
+		KnownIssue map[string][]Entry
+		// In Markdown... TBD
+		Upgrade map[string][]Entry
+		Other   map[string][]Entry
 	}
 
 	td := TemplateData{
-		buildTitleByComponents(r.changelog.Entries), r.changelog.Version, r.repo, r.changelog,
+		buildTitleByComponents(r.changelog.Entries),
+		r.changelog.Version,
+		r.repo,
+		r.changelog,
 		collectKinds(r.changelog.Entries),
 		// In Markdown, this goes to release notes
 		collectByKindMap(r.changelog.Entries, Enhancement),
@@ -115,6 +123,11 @@ func (r Renderer) Render() error {
 				}
 				return s
 			},
+			// Indent lines
+			"indent": func(s string) string {
+				re := regexp.MustCompile(`\n|\r|^`)
+				return re.ReplaceAllString(s, "\n  ")
+			},
 			// Ensure components have section styling
 			"header2": func(s1 string) string {
 				return fmt.Sprintf("**%s**", s1)

internal/settings/settings.go

@@ -59,7 +59,7 @@ func setDefaults() {
 		viper.GetString("fragment_path")))
 
 	viper.SetDefault("changelog_destination", "changelog")
-	viper.SetDefault("rendered_changelog_destination", "changelog")
+	// viper.SetDefault("rendered_changelog_destination", "changelog")
 
 	viper.SetDefault("template", "asciidoc-embedded")
 }