Script for generating changelog file

Author: MaciejKaras

requirements.txt

@@ -33,6 +33,7 @@ pytest-mock==3.14.1
 wrapt==1.17.2
 botocore==1.38.33
 boto3==1.38.33
+python-frontmatter==1.1.0
 
 # from kubeobject
 freezegun==1.5.2

scripts/release/calculate_next_version.py

@@ -3,36 +3,48 @@
 
 from git import Repo
 
+from scripts.release.changelog import (
+    DEFAULT_CHANGELOG_PATH,
+    DEFAULT_INITIAL_GIT_TAG_VERSION,
+)
 from scripts.release.release_notes import calculate_next_version_with_changelog
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument(
+        "-p",
         "--path",
-        action="store",
         default=".",
+        metavar="",
+        action="store",
         type=pathlib.Path,
         help="Path to the Git repository. Default is the current directory '.'",
     )
     parser.add_argument(
-        "--changelog_path",
-        default="changelog/",
+        "-c",
+        "--changelog-path",
+        default=DEFAULT_CHANGELOG_PATH,
+        metavar="",
         action="store",
         type=str,
-        help="Path to the changelog directory relative to the repository root. Default is 'changelog/'",
+        help=f"Path to the changelog directory relative to the repository root. Default is '{DEFAULT_CHANGELOG_PATH}'",
     )
     parser.add_argument(
-        "--initial_commit_sha",
+        "-s",
+        "--initial-commit-sha",
+        metavar="",
         action="store",
         type=str,
         help="SHA of the initial commit to start from if no previous version tag is found.",
     )
     parser.add_argument(
-        "--initial_version",
-        default="1.0.0",
+        "-v",
+        "--initial-version",
+        default=DEFAULT_INITIAL_GIT_TAG_VERSION,
+        metavar="",
         action="store",
         type=str,
-        help="Version to use if no previous version tag is found. Default is '1.0.0'",
+        help=f"Version to use if no previous version tag is found. Default is '{DEFAULT_INITIAL_GIT_TAG_VERSION}'",
     )
     parser.add_argument("--output", "-o", type=pathlib.Path)
     args = parser.parse_args()

scripts/release/changelog.py

@@ -6,15 +6,18 @@
 import frontmatter
 from git import Commit, Repo
 
-CHANGELOG_PATH = "changelog/"
+DEFAULT_CHANGELOG_PATH = "changelog/"
+DEFAULT_INITIAL_GIT_TAG_VERSION = "1.0.0"
+FILENAME_DATE_FORMAT = "%Y%m%d"
+FRONTMATTER_DATE_FORMAT = "%Y-%m-%d"
 
 PRELUDE_ENTRIES = ["prelude"]
 BREAKING_CHANGE_ENTRIES = ["breaking", "major"]
 FEATURE_ENTRIES = ["feat", "feature"]
 BUGFIX_ENTRIES = ["fix", "bugfix", "hotfix", "patch"]
 
 
-class ChangeType(StrEnum):
+class ChangeKind(StrEnum):
     PRELUDE = "prelude"
     BREAKING = "breaking"
     FEATURE = "feature"
@@ -23,7 +26,7 @@ class ChangeType(StrEnum):
 
 
 class ChangeMeta:
-    def __init__(self, date: datetime, kind: ChangeType, title: str):
+    def __init__(self, date: datetime, kind: ChangeKind, title: str):
         self.date = date
         self.kind = kind
         self.title = title
@@ -33,7 +36,7 @@ def get_changelog_entries(
     previous_version_commit: Commit,
     repo: Repo,
     changelog_sub_path: str,
-) -> list[tuple[ChangeType, str]]:
+) -> list[tuple[ChangeKind, str]]:
     changelog = []
 
     # Compare previous version commit with current working tree
@@ -77,40 +80,51 @@ def extract_changelog_data(working_dir: str, file_path: str) -> (ChangeMeta, str
     return change_meta, contents
 
 
-def extract_date_and_kind_from_file_name(file_name: str) -> (datetime, ChangeType):
+def extract_date_and_kind_from_file_name(file_name: str) -> (datetime, ChangeKind):
     match = re.match(r"(\d{8})_([a-zA-Z]+)_(.+)\.md", file_name)
     if not match:
         raise Exception(f"{file_name} - doesn't match expected pattern")
 
     date_str, kind_str, _ = match.groups()
     try:
-        date = datetime.datetime.strptime(date_str, "%Y%m%d").date()
-    except Exception:
-        raise Exception(f"{file_name} - date part {date_str} is not in the expected format YYYYMMDD")
+        date = parse_change_date(date_str, FILENAME_DATE_FORMAT)
+    except Exception as e:
+        raise Exception(f"{file_name} - {e}")
 
-    kind = get_change_type(kind_str)
+    kind = get_change_kind(kind_str)
 
     return date, kind
 
 
-def get_change_type(kind_str: str) -> ChangeType:
+def parse_change_date(date_str: str, date_format: str) -> datetime:
+    try:
+        date = datetime.datetime.strptime(date_str, date_format).date()
+    except Exception:
+        raise Exception(f"date {date_str} is not in the expected format {date_format}")
+
+    return date
+
+
+def get_change_kind(kind_str: str) -> ChangeKind:
     if kind_str.lower() in PRELUDE_ENTRIES:
-        return ChangeType.PRELUDE
+        return ChangeKind.PRELUDE
     if kind_str.lower() in BREAKING_CHANGE_ENTRIES:
-        return ChangeType.BREAKING
+        return ChangeKind.BREAKING
     elif kind_str.lower() in FEATURE_ENTRIES:
-        return ChangeType.FEATURE
+        return ChangeKind.FEATURE
     elif kind_str.lower() in BUGFIX_ENTRIES:
-        return ChangeType.FIX
+        return ChangeKind.FIX
     else:
-        return ChangeType.OTHER
+        return ChangeKind.OTHER
 
 
 def strip_changelog_entry_frontmatter(file_contents: str) -> (ChangeMeta, str):
     """Strip the front matter from a changelog entry."""
     data = frontmatter.loads(file_contents)
 
-    meta = ChangeMeta(date=data["date"], title=str(data["title"]), kind=get_change_type(str(data["kind"])))
+    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"

scripts/release/changelog_test.py

@@ -1,9 +1,8 @@
 import datetime
 
 import pytest
-
 from changelog import (
-    ChangeType,
+    ChangeKind,
     extract_date_and_kind_from_file_name,
     strip_changelog_entry_frontmatter,
 )
@@ -13,65 +12,65 @@ def test_extract_changelog_data_from_file_name():
     # Test prelude
     assert extract_date_and_kind_from_file_name("20250502_prelude_release_notes.md") == (
         datetime.date(2025, 5, 2),
-        ChangeType.PRELUDE,
+        ChangeKind.PRELUDE,
     )
 
     # Test breaking changes
     assert extract_date_and_kind_from_file_name("20250101_breaking_api_update.md") == (
         datetime.date(2025, 1, 1),
-        ChangeType.BREAKING,
+        ChangeKind.BREAKING,
     )
     assert extract_date_and_kind_from_file_name("20250508_breaking_remove_deprecated.md") == (
         datetime.date(2025, 5, 8),
-        ChangeType.BREAKING,
+        ChangeKind.BREAKING,
     )
     assert extract_date_and_kind_from_file_name("20250509_major_schema_change.md") == (
         datetime.date(2025, 5, 9),
-        ChangeType.BREAKING,
+        ChangeKind.BREAKING,
     )
 
     # Test features
     assert extract_date_and_kind_from_file_name("20250509_feature_new_dashboard.md") == (
         datetime.date(2025, 5, 9),
-        ChangeType.FEATURE,
+        ChangeKind.FEATURE,
     )
     assert extract_date_and_kind_from_file_name("20250511_feat_add_metrics.md") == (
         datetime.date(2025, 5, 11),
-        ChangeType.FEATURE,
+        ChangeKind.FEATURE,
     )
 
     # Test fixes
     assert extract_date_and_kind_from_file_name("20251210_fix_olm_missing_images.md") == (
         datetime.date(2025, 12, 10),
-        ChangeType.FIX,
+        ChangeKind.FIX,
     )
     assert extract_date_and_kind_from_file_name("20251010_bugfix_memory_leak.md") == (
         datetime.date(2025, 10, 10),
-        ChangeType.FIX,
+        ChangeKind.FIX,
     )
     assert extract_date_and_kind_from_file_name("20250302_hotfix_security_issue.md") == (
         datetime.date(2025, 3, 2),
-        ChangeType.FIX,
+        ChangeKind.FIX,
     )
     assert extract_date_and_kind_from_file_name("20250301_patch_typo_correction.md") == (
         datetime.date(2025, 3, 1),
-        ChangeType.FIX,
+        ChangeKind.FIX,
     )
 
     # Test other
     assert extract_date_and_kind_from_file_name("20250520_docs_update_readme.md") == (
         datetime.date(2025, 5, 20),
-        ChangeType.OTHER,
+        ChangeKind.OTHER,
     )
     assert extract_date_and_kind_from_file_name("20250610_refactor_codebase.md") == (
         datetime.date(2025, 6, 10),
-        ChangeType.OTHER,
+        ChangeKind.OTHER,
     )
 
     # Invalid date part (day 40 does not exist)
     with pytest.raises(Exception) as e:
         extract_date_and_kind_from_file_name("20250640_refactor_codebase.md")
-    assert str(e.value) == "20250640_refactor_codebase.md - date part 20250640 is not in the expected format YYYYMMDD"
+    assert str(e.value) == "20250640_refactor_codebase.md - date 20250640 is not in the expected format YYYYMMDD"
 
     # Wrong file name format (date part)
     with pytest.raises(Exception) as e:
@@ -99,7 +98,7 @@ def test_strip_changelog_entry_frontmatter():
     change_meta, contents = strip_changelog_entry_frontmatter(file_contents)
 
     assert change_meta.title == "This is my change"
-    assert change_meta.kind == ChangeType.FEATURE
+    assert change_meta.kind == ChangeKind.FEATURE
     assert change_meta.date == datetime.date(2025, 7, 10)
 
     assert (

scripts/release/conftest.py

@@ -5,11 +5,11 @@
 from _pytest.fixtures import fixture
 from git import Repo
 
-from scripts.release.changelog import CHANGELOG_PATH
+from scripts.release.changelog import DEFAULT_CHANGELOG_PATH
 
 
 @fixture(scope="session")
-def git_repo(change_log_path: str = CHANGELOG_PATH) -> Repo:
+def git_repo(change_log_path: str = DEFAULT_CHANGELOG_PATH) -> Repo:
     """
     Create a temporary git repository for testing.
     Visual representation of the repository structure is in test_git_repo.mmd (mermaid/gitgraph https://mermaid.js.org/syntax/gitgraph.html).

scripts/release/create_changelog.py

@@ -0,0 +1,105 @@
+import argparse
+import datetime
+import os
+import re
+
+from scripts.release.changelog import (
+    BREAKING_CHANGE_ENTRIES,
+    BUGFIX_ENTRIES,
+    DEFAULT_CHANGELOG_PATH,
+    FEATURE_ENTRIES,
+    FILENAME_DATE_FORMAT,
+    FRONTMATTER_DATE_FORMAT,
+    PRELUDE_ENTRIES,
+    parse_change_date,
+)
+
+MAX_TITLE_LENGTH = 50
+
+
+def sanitize_title(title: str) -> str:
+    # Remove non-alphabetic and space characters
+    regex = re.compile("[^a-zA-Z ]+")
+    title = regex.sub("", title)
+
+    # Lowercase and split by space
+    words = [word.lower() for word in title.split(" ")]
+
+    result = words[0]
+
+    for word in words[1:]:
+        if len(result) + len("_") + len(word) <= MAX_TITLE_LENGTH:
+            result = result + "_" + word
+        else:
+            break
+
+    return result
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument(
+        "-c",
+        "--changelog-path",
+        default=DEFAULT_CHANGELOG_PATH,
+        metavar="",
+        action="store",
+        type=str,
+        help=f"Path to the changelog directory relative to the repository root. Default is {DEFAULT_CHANGELOG_PATH}",
+    )
+    parser.add_argument(
+        "-d",
+        "--date",
+        default=datetime.datetime.now().strftime(FRONTMATTER_DATE_FORMAT),
+        metavar="",
+        action="store",
+        type=str,
+        help=f"Date in 'YYYY-MM-DD' format to use for the changelog entry. Default is today's date",
+    )
+    parser.add_argument(
+        "-e",
+        "--editor",
+        action="store_true",
+        help="Open the created changelog entry in the default editor (if set, otherwise uses 'vi'). Default is True",
+    )
+    parser.add_argument(
+        "-k",
+        "--kind",
+        action="store",
+        metavar="",
+        required=True,
+        type=str,
+        help=f"""Kind of the changelog entry:
+  - '{".".join(PRELUDE_ENTRIES)}' for prelude entries
+  - '{".".join(BREAKING_CHANGE_ENTRIES)}' for breaking change entries
+  - '{".".join(FEATURE_ENTRIES)}' for feature entries
+  - '{".".join(BUGFIX_ENTRIES)}' for bugfix entries
+  - everything else will be treated as other entries""",
+    )
+    parser.add_argument("title", type=str, help="Title for the changelog entry")
+    args = parser.parse_args()
+
+    date = parse_change_date(args.date, FRONTMATTER_DATE_FORMAT)
+    sanitized_title = sanitize_title(args.title)
+    filename = f"{datetime.datetime.strftime(date, FILENAME_DATE_FORMAT)}_{args.kind}_{sanitized_title}.md"
+
+    working_dir = os.getcwd()
+    changelog_path = os.path.join(working_dir, args.changelog_path, filename)
+
+    # Create directory if it doesn't exist
+    os.makedirs(os.path.dirname(changelog_path), exist_ok=True)
+
+    # Create the file
+    with open(changelog_path, "w") as f:
+        # Add frontmatter based on args
+        f.write("---\n")
+        f.write(f"title: {args.title}\n")
+        f.write(f"kind: {args.kind}\n")
+        f.write(f"date: {date}\n")
+        f.write("---\n\n")
+
+    if args.editor:
+        editor = os.environ.get("EDITOR", "vi")  # Fallback to vim if EDITOR is not set
+        os.system(f'{editor} "{changelog_path}"')
+
+    print(f"Created changelog entry at: {changelog_path}")