Added support for renovate changelogs (#253)

Author: rhysyngsun

renovate-config.json

@@ -2,5 +2,12 @@
   "allowedPostUpgradeCommands": [
       "^uv sync",
       "^uv .+"
-  ]
+  ],
+  "postUpgradeTasks": {
+    "commands": [
+      "uv run scripts/changelog.py create-renovate -m 'Updated `{{{depName}}}` from {{{currentVersion}}} -> {{{newVersion}}}'",
+      "uv sync"
+    ],
+    "executionMode": "update"
+  }
 }

scripts/apps.py

@@ -5,8 +5,58 @@
 from pathlib import Path
 
 import toml
+from git import Commit
 
+from scripts.changes import Changes
 from scripts.contextlibs import chdir
+from scripts.project import Project
+
+
+class App:
+    module_name: str | None = None
+    project: Project | None = None
+
+    @classmethod
+    def create(cls, project: Project, module_name: str):
+        app = App()
+        app.project = project
+        app.module_name = module_name
+        return app
+
+    @property
+    def pyproject(self):
+        with open(self.absolute_path / "pyproject.toml") as f:  # noqa: PTH123
+            return toml.loads(f.read())
+
+    @property
+    def name(self) -> str:
+        return self.pyproject["project"]["name"]
+
+    @property
+    def version(self) -> str:
+        return self.pyproject["project"]["version"]
+
+    @property
+    def version_git_tag(self):
+        return f"{self.name}/v{self.version}"
+
+    @cached_property
+    def absolute_path(self) -> Path:
+        return get_app_dir(self.module_name).absolute()
+
+    @cached_property
+    def relative_path(self):
+        return self.absolute_path.relative_to(self.project.path)
+
+    @contextmanager
+    def with_app_dir(self):
+        with chdir(self.absolute_path):
+            yield
+
+    def get_changes(self, base_commit: Commit, target_commit: Commit) -> Changes:
+        return Changes.from_app_commits(
+            app=self, base_commit=base_commit, target_commit=target_commit
+        )
 
 
 def get_source_dir() -> Path:
@@ -19,7 +69,7 @@ def get_app_dir(path: str) -> Path:
     return get_source_dir() / path
 
 
-def list_apps() -> list[Path]:
+def list_app_paths() -> list[Path]:
     """List the apps in the repo"""
     return sorted(
         dir_path
@@ -32,34 +82,9 @@ def list_apps() -> list[Path]:
 
 def list_app_names() -> list[str]:
     """List the app names"""
-    return [name.stem for name in list_apps()]
+    return [name.stem for name in list_app_paths()]
 
 
-class App:
-    module_name: str
-
-    @property
-    def pyproject(self):
-        with open(self.app_dir / "pyproject.toml") as f:  # noqa: PTH123
-            return toml.loads(f.read())
-
-    @property
-    def name(self):
-        return self.pyproject["project"]["name"]
-
-    @property
-    def version(self):
-        return self.pyproject["project"]["version"]
-
-    @property
-    def version_git_tag(self):
-        return f"{self.name}/v{self.version}"
-
-    @cached_property
-    def app_dir(self) -> Path:
-        return get_app_dir(self.module_name).absolute()
-
-    @contextmanager
-    def with_app_dir(self):
-        with chdir(self.app_dir):
-            yield
+def list_apps(project: Project) -> list[App]:
+    """Get a list of App instances"""
+    return [App.create(project, name) for name in list_app_names()]

scripts/changelog.py

@@ -1,6 +1,6 @@
-from fnmatch import fnmatch
 from os import makedirs
-from textwrap import indent
+from pathlib import Path
+from textwrap import dedent, indent
 
 from click import echo
 from click_log import simple_verbosity_option
@@ -33,7 +33,7 @@ def changelog(ctx):
 @app_option
 @pass_app
 @pass_context
-def list_all(ctx: Context, app: App):  # noqa: ARG001
+def list_all(_ctx: Context, app: App):
     """Print out the current set of changes"""
     scriv = Scriv()
     fragments = scriv.fragments_to_combine()
@@ -48,24 +48,15 @@ def list_all(ctx: Context, app: App):  # noqa: ARG001
 
 def _echo_change(change: Diff):
     """Echo the change to stdout"""
+
     line = [change.change_type, change.a_path]
 
     if change.renamed_file:
-        line.extend(["->", changelog.b_path])
+        line.extend(["->", change.b_path])
 
     echo(indent(" ".join(line), "\t"))
 
 
-def _is_source_excluded(path) -> bool:
-    excluded_paths = ["*/changelog.d/*", "*/CHANGELOG.md"]
-    return any([fnmatch(path, exclude) for exclude in excluded_paths])  # noqa: C419
-
-
-def _is_changelog_excluded(path) -> bool:
-    excluded_paths = ["*/scriv.ini"]
-    return any([fnmatch(path, exclude) for exclude in excluded_paths])  # noqa: C419
-
-
 @changelog.command()
 @option(
     "-b",
@@ -89,58 +80,30 @@ def check(ctx: Context, project: Project, base: str, target: str):
 
     is_error = False
 
-    for app_abs_path in list_apps():
-        app_rel_path = app_abs_path.relative_to(project.path)
-
-        # we count these towards a changelog being present
-        # but not against the absence of one
-        top_level_dependency_changes = [
-            change
-            for change in base_commit.diff(target_commit, paths=["uv.lock"])
-            if not _is_source_excluded(change.a_path)
-            and not _is_source_excluded(change.b_path)
-        ]
-        has_top_level_dependency_changes = len(top_level_dependency_changes) > 0
-
-        source_changes = [
-            change
-            for change in base_commit.diff(target_commit, paths=[app_rel_path])
-            if not _is_source_excluded(change.a_path)
-            and not _is_source_excluded(change.b_path)
-        ]
-        has_source_changes = len(source_changes) > 0
-
-        changelogd_changes = [
-            change
-            for change in base_commit.diff(
-                target_commit, paths=[app_rel_path / "changelog.d"]
-            )
-            if not _is_changelog_excluded(change.a_path)
-            and not _is_changelog_excluded(change.b_path)
-        ]
-        has_changelogd_changes = len(changelogd_changes) > 0
-
-        if has_source_changes and not has_changelogd_changes:
-            echo(f"Changelog(s) are missing in {app_rel_path} for these changes:")
-            for change in source_changes:
+    for app in list_apps(project):
+        changes = app.get_changes(base_commit=base_commit, target_commit=target_commit)
+
+        if changes.has_source_changes and not changes.has_changelogd_changes:
+            echo(f"Changelog(s) are missing in {app.relative_path} for these changes:")
+            for change in changes.source_changes:
                 _echo_change(change)
             is_error = True
             echo("")
         elif (
-            not has_source_changes
-            and not has_top_level_dependency_changes
-            and has_changelogd_changes
+            not changes.has_source_changes
+            and not changes.has_top_level_dependency_changes
+            and changes.has_changelogd_changes
         ):
             echo(
-                f"Changelog(s) are present in {app_rel_path} but there are no source changes:"  # noqa: E501
+                f"Changelog(s) are present in {app.relative_path} but there are no source changes:"  # noqa: E501
             )
-            for change in changelogd_changes:
+            for change in changes.changelogd_changes:
                 _echo_change(change)
             is_error = True
             echo("")
 
         # verify the fragments aren't empty
-        with chdir(app_abs_path):
+        with chdir(app.absolute_path):
             scriv = Scriv()
             fragments = scriv.fragments_to_combine()
             for fragment in fragments:
@@ -149,7 +112,9 @@ def check(ctx: Context, project: Project, base: str, target: str):
         empty_fragments = list(filter(lambda frag: not frag.content.strip(), fragments))
 
         if empty_fragments:
-            echo(f"Changelog(s) are present in {app_rel_path} but have no content:")
+            echo(
+                f"Changelog(s) are present in {app.relative_path} but have no content:"
+            )
             for fragment in empty_fragments:
                 echo(f"\t{fragment.path}")
             is_error = True
@@ -159,5 +124,34 @@ def check(ctx: Context, project: Project, base: str, target: str):
         ctx.exit(1)
 
 
+@changelog.command("create-renovate")
+@option(
+    "-m",
+    "--message",
+    help="The message for the changelog line",
+    required=True,
+)
+@pass_project
+def create_renovate(project: Project, message: str):
+    """Create a changelog for renovate"""
+    for changed in project.repo.head.commit.diff(None):
+        if not changed.a_path.endswith("pyproject.toml"):
+            continue
+
+        echo(f"Adding changelog for: {changed.a_path}")
+
+        with chdir(Path(changed.a_path).parent):
+            scriv = Scriv()
+            frag = scriv.new_fragment()
+
+            frag.content = dedent(
+                f"""
+                ### Changed
+
+                - {message}"""
+            )
+            frag.write()
+
+
 if __name__ == "__main__":
     changelog()

scripts/changes.py

@@ -0,0 +1,87 @@
+from ast import TypeAlias
+from dataclasses import dataclass
+from fnmatch import fnmatch
+from functools import cached_property
+from typing import TYPE_CHECKING
+
+from git import Commit, Diff
+
+if TYPE_CHECKING:
+    from scripts.apps import App
+else:
+    App: TypeAlias = None
+
+
+@dataclass(frozen=True)
+class Changes:
+    """
+    Representation for various categories of changes in git.
+    """
+
+    all_changes: list[Diff]
+    top_level_dependency_changes: list[Diff]
+    source_changes: list[Diff]
+    changelogd_changes: list[Diff]
+
+    @cached_property
+    def has_top_level_dependency_changes(self) -> bool:
+        return len(self.top_level_dependency_changes) > 0
+
+    def has_source_changes(self) -> bool:
+        return len(self.source_changes) > 0
+
+    def has_changelogd_changes(self) -> bool:
+        return len(self.changelogd_changes) > 0
+
+    @classmethod
+    def from_app_commits(cls, *, app: App, base_commit: Commit, target_commit: Commit):
+        """Create the Changes object from an app and commit range"""
+        all_changes = base_commit.diff(target_commit)
+        # we count these towards a changelog being present
+        # but not against the absence of one
+        top_level_dependency_changes = base_commit.diff(
+            target_commit, paths=["uv.lock"]
+        )
+
+        source_changes = [
+            change
+            for change in base_commit.diff(target_commit, paths=[app.relative_path])
+            if not _is_source_excluded(change.a_path)
+            and not _is_source_excluded(change.b_path)
+        ]
+
+        changelogd_changes = [
+            change
+            for change in base_commit.diff(
+                target_commit, paths=[app.relative_path / "changelog.d"]
+            )
+            if not _is_changelog_excluded(change.a_path)
+            and not _is_changelog_excluded(change.b_path)
+        ]
+
+        return cls(
+            all_changes,
+            top_level_dependency_changes,
+            source_changes,
+            changelogd_changes,
+        )
+
+
+def _is_source_excluded(path: str | None) -> bool:
+    """Return True if the source path is excluded"""
+    if path is None:
+        return False
+
+    excluded_paths = ["*/changelog.d/*", "*/CHANGELOG.md"]
+
+    return any(fnmatch(path, exclude) for exclude in excluded_paths)
+
+
+def _is_changelog_excluded(path: str | None) -> bool:
+    """Return True if the changelog path is excluded"""
+    if path is None:
+        return False
+
+    excluded_paths = ["*/scriv.ini"]
+
+    return any(fnmatch(path, exclude) for exclude in excluded_paths)

scripts/contextlibs.py

@@ -1,10 +1,11 @@
 from contextlib import contextmanager
+from os import PathLike
 from os import chdir as _chdir
 from pathlib import Path
 
 
 @contextmanager
-def chdir(path):
+def chdir(path: str | bytes | PathLike[str]):
     original = Path.cwd()
 
     try: