internal/generator: Update markdown formatting (#8)

Signed-off-by: timflannagan <[email protected]>

Author: timflannagan

internal/generator/generator.go

@@ -15,11 +15,11 @@ var releaseNoteRE = regexp.MustCompile("(?s)```release-note\\s*(.*?)\\s*```")
 
 // Supported kinds for bucket headers
 var kindHeaders = map[string]string{
-	"new_feature":     "🚀 Features",
-	"bug_fix":         "🐛 Bug Fixes",
-	"breaking_change": "💥 Breaking Changes",
-	"documentation":   "📝 Documentation",
-	"performance":     "⚡ Performance Improvements",
+	"new_feature":     "## Features",
+	"bug_fix":         "## Bug Fixes",
+	"breaking_change": "## Breaking Changes",
+	"documentation":   "## Documentation",
+	"performance":     "## Performance Improvements",
 }
 
 // Generator handles changelog generation for a repository
@@ -119,13 +119,14 @@ func (g *Generator) generateChangelog(prs []*github.PullRequest) string {
 	sort.Strings(kinds)
 
 	// build the changelog
+	changelog.WriteString("# Changelog\n")
 	for _, kind := range kinds {
 		header := kindHeaders[kind]
 		prs := buckets[kind]
 		if len(prs) == 0 {
 			continue
 		}
-		changelog.WriteString(fmt.Sprintf("\n## %s\n\n", header))
+		changelog.WriteString(fmt.Sprintf("\n%s\n\n", header))
 		for _, pr := range prs {
 			body := pr.GetBody()
 			if body == "" {

internal/generator/generator_test.go

@@ -51,7 +51,9 @@ func TestGenerateChangelog(t *testing.T) {
 				}},
 			}},
 			expectedChangelog: `
-## 🚀 Features
+# Changelog
+
+## Features
 
 - My note for PR42 (#42)
 `,
@@ -76,8 +78,10 @@ func TestGenerateChangelog(t *testing.T) {
 					Name: github.Ptr("irrelevant-label"),
 				}},
 			}},
-			expectedChangelog: "",
-			expectError:       false,
+			expectedChangelog: `
+# Changelog
+`,
+			expectError: false,
 		},
 		{
 			name:         "Valid/Multiple PRs with different kinds",
@@ -119,15 +123,17 @@ func TestGenerateChangelog(t *testing.T) {
 				},
 			},
 			expectedChangelog: `
-## 💥 Breaking Changes
+# Changelog
+
+## Breaking Changes
 
 - Removed old feature (#44)
 
-## 🐛 Bug Fixes
+## Bug Fixes
 
 - Fixed a bug (#43)
 
-## 🚀 Features
+## Features
 
 - Implement new feature (#42)
 `,