Using ChangeEntry type

Author: MaciejKaras

scripts/release/changelog.py

@@ -26,18 +26,19 @@ class ChangeKind(StrEnum):
     OTHER = "other"
 
 
-class ChangeMeta:
-    def __init__(self, date: datetime, kind: ChangeKind, title: str):
+class ChangeEntry:
+    def __init__(self, date: datetime, kind: ChangeKind, title: str, contents: str):
         self.date = date
         self.kind = kind
         self.title = title
+        self.contents = contents
 
 
 def get_changelog_entries(
     previous_version_commit: Commit,
     repo: Repo,
     changelog_sub_path: str,
-) -> list[tuple[ChangeKind, str]]:
+) -> list[ChangeEntry]:
     changelog = []
 
     # Compare previous version commit with current working tree
@@ -51,34 +52,33 @@ def get_changelog_entries(
     for diff_item in diff_index.iter_change_type("A"):
         file_path = diff_item.b_path
 
-        change_meta, contents = extract_changelog_data(repo.working_dir, file_path)
-
-        changelog.append((str(change_meta.kind), contents))
+        change_entry = extract_changelog_entry(repo.working_dir, file_path)
+        changelog.append(change_entry)
 
     return changelog
 
 
-def extract_changelog_data(working_dir: str, file_path: str) -> (ChangeMeta, str):
+def extract_changelog_entry(working_dir: str, file_path: str) -> ChangeEntry:
     file_name = os.path.basename(file_path)
     date, kind = extract_date_and_kind_from_file_name(file_name)
 
     abs_file_path = os.path.join(working_dir, file_path)
     with open(abs_file_path, "r") as file:
         file_content = file.read()
 
-    change_meta, contents = strip_changelog_entry_frontmatter(file_content)
+    change_entry = extract_changelog_entry_from_contents(file_content)
 
-    if change_meta.date != date:
+    if change_entry.date != date:
         raise Exception(
-            f"{file_name} - date in front matter {change_meta.date} does not match date extracted from file name {date}"
+            f"{file_name} - date in front matter {change_entry.date} does not match date extracted from file name {date}"
         )
 
-    if change_meta.kind != kind:
+    if change_entry.kind != kind:
         raise Exception(
-            f"{file_name} - kind in front matter {change_meta.kind} does not match kind extracted from file name {kind}"
+            f"{file_name} - kind in front matter {change_entry.kind} does not match kind extracted from file name {kind}"
         )
 
-    return change_meta, contents
+    return change_entry
 
 
 def extract_date_and_kind_from_file_name(file_name: str) -> (datetime, ChangeKind):
@@ -119,18 +119,15 @@ def get_change_kind(kind_str: str) -> ChangeKind:
         return ChangeKind.OTHER
 
 
-def strip_changelog_entry_frontmatter(file_contents: str) -> (ChangeMeta, str):
-    """Strip the front matter from a changelog entry."""
+def extract_changelog_entry_from_contents(file_contents: str) -> ChangeEntry:
     data = frontmatter.loads(file_contents)
 
     kind = get_change_kind(str(data["kind"]))
     date = parse_change_date(str(data["date"]), FRONTMATTER_DATE_FORMAT)
-    meta = ChangeMeta(date=date, title=str(data["title"]), kind=kind)
-
     ## Add newline to contents so the Markdown file also contains a newline at the end
     contents = data.content + "\n"
 
-    return meta, contents
+    return ChangeEntry(date=date, title=str(data["title"]), kind=kind, contents=contents)
 
 
 def get_changelog_filename(title: str, kind: ChangeKind, date: datetime) -> str:

scripts/release/changelog_test.py

@@ -4,9 +4,9 @@
 from changelog import (
     MAX_TITLE_LENGTH,
     ChangeKind,
+    extract_changelog_entry_from_contents,
     extract_date_and_kind_from_file_name,
     sanitize_title,
-    strip_changelog_entry_frontmatter,
 )
 
 
@@ -94,14 +94,13 @@ def test_strip_changelog_entry_frontmatter():
   * Added new property [spec.search](https://www.mongodb.com/docs/kubernetes/current/mongodb/specification/#spec-search) to enable MongoDB Search.
 """
 
-    change_meta, contents = strip_changelog_entry_frontmatter(file_contents)
-
-    assert change_meta.title == "This is my change"
-    assert change_meta.kind == ChangeKind.FEATURE
-    assert change_meta.date == datetime.date(2025, 7, 10)
+    change_entry = extract_changelog_entry_from_contents(file_contents)
 
+    assert change_entry.title == "This is my change"
+    assert change_entry.kind == ChangeKind.FEATURE
+    assert change_entry.date == datetime.date(2025, 7, 10)
     assert (
-        contents
+        change_entry.contents
         == """* **MongoDB**: public search preview release of MongoDB Search (Community Edition) is now available.
   * Added new property [spec.search](https://www.mongodb.com/docs/kubernetes/current/mongodb/specification/#spec-search) to enable MongoDB Search.
 """

scripts/release/release_notes.py

@@ -7,6 +7,7 @@
 from scripts.release.changelog import (
     DEFAULT_CHANGELOG_PATH,
     DEFAULT_INITIAL_GIT_TAG_VERSION,
+    ChangeEntry,
     ChangeKind,
     get_changelog_entries,
 )
@@ -44,23 +45,23 @@ def generate_release_notes(
 
     parameters = {
         "version": version,
-        "preludes": [c[1] for c in changelog if c[0] == ChangeKind.PRELUDE],
-        "breaking_changes": [c[1] for c in changelog if c[0] == ChangeKind.BREAKING],
-        "features": [c[1] for c in changelog if c[0] == ChangeKind.FEATURE],
-        "fixes": [c[1] for c in changelog if c[0] == ChangeKind.FIX],
-        "others": [c[1] for c in changelog if c[0] == ChangeKind.OTHER],
+        "preludes": [c.contents for c in changelog if c.kind == ChangeKind.PRELUDE],
+        "breaking_changes": [c.contents for c in changelog if c.kind == ChangeKind.BREAKING],
+        "features": [c.contents for c in changelog if c.kind == ChangeKind.FEATURE],
+        "fixes": [c.contents for c in changelog if c.kind == ChangeKind.FIX],
+        "others": [c.contents for c in changelog if c.kind == ChangeKind.OTHER],
     }
 
     return template.render(parameters)
 
 
 def calculate_next_version_with_changelog(
     repo: Repo, changelog_sub_path: str, initial_commit_sha: str | None, initial_version: str
-) -> (str, list[tuple[ChangeKind, str]]):
+) -> (str, list[ChangeEntry]):
     previous_version_tag, previous_version_commit = find_previous_version(repo, initial_commit_sha)
 
-    changelog: list[tuple[ChangeKind, str]] = get_changelog_entries(previous_version_commit, repo, changelog_sub_path)
-    changelog_kinds = list[ChangeKind](map(lambda x: x[0], changelog))
+    changelog: list[ChangeEntry] = get_changelog_entries(previous_version_commit, repo, changelog_sub_path)
+    changelog_kinds = list(set(entry.kind for entry in changelog))
 
     # If there is no previous version tag, we start with the initial version tag
     if not previous_version_tag: