fix(release-notes): cap changelog at ten commits since previous tag

Author: Christopher Herasme

box-rpg/tests/tools/test_release_notes.py

@@ -53,7 +53,7 @@ def test_generate_notes_lists_everything_since_previous_tag(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:
     """With a prior release, the range covers all of it with no truncation."""
-    entries = [f"abcdef{i} commit message number {i}" for i in range(12)]
+    entries = [f"abcdef{i} commit message number {i}" for i in range(8)]
     seen = _fake_git(
         monkeypatch,
         "\n".join(entries) + "\n",
@@ -66,13 +66,35 @@ def test_generate_notes_lists_everything_since_previous_tag(
     assert any(f"{PREV_TAG}..HEAD" in cmd for cmd in seen)
     assert not any("-n" in cmd for cmd in seen)
     bullets = _changelog_lines(notes)
-    assert len(bullets) == 12
+    assert len(bullets) == 8
     for entry in entries:
         short_hash, _, subject = entry.partition(" ")
         assert f"- `{short_hash}` {subject}" in bullets
     assert "...and more" not in notes
 
 
+def test_generate_notes_truncates_range_since_previous_tag(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """A long range since the previous tag caps at ten with an overflow hint."""
+    entries = [f"abcdef{i} commit message number {i}" for i in range(12)]
+    _fake_git(
+        monkeypatch,
+        "\n".join(entries) + "\n",
+        describe_stdout=PREV_TAG + "\n",
+        describe_code=0,
+    )
+
+    notes = release_notes.generate_notes(".", TAG)
+
+    bullets = _changelog_lines(notes)
+    assert len(bullets) == 10
+    for entry in entries[:10]:
+        short_hash, _, subject = entry.partition(" ")
+        assert f"- `{short_hash}` {subject}" in bullets
+    assert "...and more" in notes
+
+
 def test_generate_notes_ignores_non_release_tag(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:

tools/release_notes.py

@@ -119,9 +119,10 @@ def _changelog_lines(commits: list[str]) -> list[str]:
 def generate_notes(repo_root: str | Path, tag: str) -> str:
     """Build the release notes for ``tag`` from the static text plus git log.
 
-    The changelog spans the commits since the previous release tag. Only
-    when no previous tag exists (first release ever, tagless checkout) it
-    falls back to the most recent commits, hinting at truncation.
+    The changelog spans the commits since the previous release tag, capped
+    at the most recent ``MAX_COMMITS`` to avoid flooding the release notes.
+    Only when no previous tag exists (first release ever, tagless checkout)
+    it falls back to the most recent commits, hinting at truncation.
     """
     static = (
         f"Standalone AppImage of the box-gui frontend (GTK4 + libadwaita)"
@@ -157,8 +158,9 @@ def generate_notes(repo_root: str | Path, tag: str) -> str:
         shown = recent[:MAX_COMMITS]
         truncated = len(recent) > MAX_COMMITS
     else:
-        shown = _commits_since(repo_root, base_tag)
-        truncated = False
+        commits = _commits_since(repo_root, base_tag)
+        shown = commits[:MAX_COMMITS]
+        truncated = len(commits) > MAX_COMMITS
     if not shown:
         return f"{static}\n\n{header}"
     changelog = "\n".join(_changelog_lines(shown))