From 4acafb6132cb212acf6f2f0c8fec3e62a0ca7348 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julian=20T=C3=B6lle?= <julian.toelle97@gmail.com>
Date: Sat, 23 Aug 2025 22:25:35 +0200
Subject: [PATCH] feat: highlight breaking changes in release notes

Add a `**BREAKING**` prefix to any entries in the changelog that are
marked as breaking changes.

Closes #225
---
 internal/changelog/changelog.md.tpl  |  2 +-
 internal/changelog/changelog_test.go | 17 +++++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/internal/changelog/changelog.md.tpl b/internal/changelog/changelog.md.tpl
index 50907eb..0a73dd5 100644
--- a/internal/changelog/changelog.md.tpl
+++ b/internal/changelog/changelog.md.tpl
@@ -1,5 +1,5 @@
 {{define "entry" -}}
-- {{ if .Scope }}**{{.Scope}}**: {{end}}{{.Description}}
+- {{ if .BreakingChange}}**BREAKING**: {{end}}{{ if .Scope }}**{{.Scope}}**: {{end}}{{.Description}}
 {{ end }}
 
 {{- if not .Formatting.HideVersionTitle }}
diff --git a/internal/changelog/changelog_test.go b/internal/changelog/changelog_test.go
index a969730..e4fe52f 100644
--- a/internal/changelog/changelog_test.go
+++ b/internal/changelog/changelog_test.go
@@ -54,6 +54,23 @@ func Test_NewChangelogEntry(t *testing.T) {
 			want:    "## [1.0.0](https://example.com/1.0.0)\n\n### Features\n\n- Foobar!\n",
 			wantErr: assert.NoError,
 		},
+		{
+			name: "single breaking change",
+			args: args{
+				analyzedCommits: []commitparser.AnalyzedCommit{
+					{
+						Commit:         git.Commit{},
+						Type:           "feat",
+						Description:    "Foobar!",
+						BreakingChange: true,
+					},
+				},
+				version: "1.0.0",
+				link:    "https://example.com/1.0.0",
+			},
+			want:    "## [1.0.0](https://example.com/1.0.0)\n\n### Features\n\n- **BREAKING**: Foobar!\n",
+			wantErr: assert.NoError,
+		},
 		{
 			name: "single fix",
 			args: args{