autopub 1.0.0a14__tar.gz → 1.0.0a16__tar.gz

{autopub-1.0.0a14 → autopub-1.0.0a16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autopub
-Version: 1.0.0a14
+Version: 1.0.0a16
 Summary: Automatic package release upon pull request merge
 Home-page: https://github.com/autopub/autopub
 License: AGPL-3.0

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/__init__.py

@@ -18,7 +18,10 @@ from autopub.exceptions import (
     ReleaseTypeInvalid,
     ReleaseTypeMissing,
 )
-from autopub.plugins import AutopubPackageManagerPlugin, AutopubPlugin
+from autopub.plugins import (
+    AutopubPackageManagerPlugin,
+    AutopubPlugin,
+)
 from autopub.types import ReleaseInfo
 
 
@@ -41,26 +44,22 @@ class Autopub:
         return hashlib.sha256(self.release_notes.encode("utf-8")).hexdigest()
 
     @property
-    def release_data_file(self) -> Path:
-        return Path(".autopub") / "release_data.json"
+    def release_info_file(self) -> Path:
+        return Path(".autopub") / "release_info.json"
 
     @property
-    def release_data(self) -> ReleaseInfo:
-        if not self.release_data_file.exists():
+    def release_info(self) -> ReleaseInfo:
+        if not self.release_info_file.exists():
             raise ArtifactNotFound()
 
-        release_data = json.loads(self.release_data_file.read_text())
+        release_info = json.loads(self.release_info_file.read_text())
 
-        if release_data["hash"] != self.release_file_hash:
+        if release_info["hash"] != self.release_file_hash:
             raise ArtifactHashMismatch()
 
-        return ReleaseInfo(
-            release_type=release_data["release_type"],
-            release_notes=release_data["release_notes"],
-            additional_info=release_data["plugin_data"],
-        )
+        return ReleaseInfo.from_dict(release_info)
 
-    def check(self) -> ReleaseInfo:
+    def check(self) -> None:
         release_file = Path(self.RELEASE_FILE_PATH)
 
         if not release_file.exists():
@@ -76,9 +75,10 @@ class Autopub:
         for plugin in self.plugins:
             plugin.on_release_notes_valid(release_info)
 
-        self._write_artifact(release_info)
+        for plugin in self.plugins:
+            plugin.post_check(release_info)
 
-        return release_info
+        self._write_artifact(release_info)
 
     def build(self) -> None:
         if not any(
@@ -91,21 +91,21 @@ class Autopub:
                 plugin.build()
 
     def prepare(self) -> None:
-        for plugin in self.plugins:
-            plugin.prepare(self.release_data)
+        release_info = self.release_info
 
-        self._write_artifact(self.release_data)
+        for plugin in self.plugins:
+            plugin.prepare(release_info)
 
         for plugin in self.plugins:
-            plugin.post_prepare(self.release_data)
+            plugin.post_prepare(release_info)
 
-        self._write_artifact(self.release_data)
+        self._write_artifact(release_info)
 
     def _delete_release_file(self) -> None:
         self.release_file.unlink(missing_ok=True)
 
     def publish(self, repository: str | None = None) -> None:
-        release_info = self.release_data
+        release_info = self.release_info
 
         for plugin in self.plugins:
             # TODO: maybe pass release info to publish method?
@@ -119,18 +119,12 @@ class Autopub:
 
     def _write_artifact(self, release_info: ReleaseInfo) -> None:
         data = {
+            **release_info.dict(),
             "hash": self.release_file_hash,
-            "release_type": release_info.release_type,
-            "release_notes": release_info.release_notes,
-            "plugin_data": {
-                key: value
-                for plugin in self.plugins
-                for key, value in plugin.data.items()
-            },
         }
 
-        self.release_data_file.parent.mkdir(exist_ok=True)
-        self.release_data_file.write_text(json.dumps(data))
+        self.release_info_file.parent.mkdir(exist_ok=True)
+        self.release_info_file.write_text(json.dumps(data))
 
     def _deprecated_load(self, release_notes: str) -> ReleaseInfo:
         # supports loading of old release notes format, which is
@@ -178,6 +172,8 @@ class Autopub:
             release_type=release_type,
             release_notes=post.content,
             additional_info=data,
+            version=None,
+            previous_version=None,
         )
 
     def _validate_release_notes(self, release_notes: str) -> ReleaseInfo:

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/cli/__init__.py

@@ -29,12 +29,14 @@ def check():
     autopub = Autopub(plugins=find_plugins(state["plugins"]))
 
     try:
-        release_info = autopub.check()
+        autopub.check()
     except AutopubException as e:
         rich.print(Panel.fit(f"[red]{e.message}"))
 
         raise typer.Exit(1) from e
     else:
+        release_info = autopub.release_info
+
         rich.print(
             Padding(
                 Group(

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/plugins/__init__.py

@@ -17,25 +17,43 @@ class AutopubPlugin:
         except subprocess.CalledProcessError as e:
             raise CommandFailed(command=command, returncode=e.returncode) from e
 
+    def post_check(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
+        ...
+
     def prepare(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
     def post_prepare(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
-    def validate_release_notes(self, release_info: ReleaseInfo):  # pragma: no cover
+    def validate_release_notes(
+        self, release_info: ReleaseInfo
+    ) -> None:  # pragma: no cover
         ...
 
-    def on_release_notes_valid(self, release_info: ReleaseInfo):  # pragma: no cover
+    def on_release_notes_valid(
+        self, release_info: ReleaseInfo
+    ) -> None:  # pragma: no cover
         ...
 
-    def on_release_notes_invalid(self, exception: AutopubException):  # pragma: no cover
+    def on_release_notes_invalid(
+        self, exception: AutopubException
+    ) -> None:  # pragma: no cover
         ...
 
     def post_publish(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
 
+@runtime_checkable
+class AutopubBumpVersionPlugin(Protocol):
+    new_version: str
+    current_version: str
+
+    def post_check(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
+        ...
+
+
 @runtime_checkable
 class AutopubPackageManagerPlugin(Protocol):
     def build(self) -> None:  # pragma: no cover

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/plugins/bump_version.py

@@ -5,11 +5,14 @@ import pathlib
 import tomlkit
 from dunamai import Version
 
-from autopub.plugins import AutopubPlugin
+from autopub.plugins import AutopubBumpVersionPlugin, AutopubPlugin
 from autopub.types import ReleaseInfo
 
 
-class BumpVersionPlugin(AutopubPlugin):
+class BumpVersionPlugin(AutopubBumpVersionPlugin, AutopubPlugin):
+    current_version: str
+    new_version: str
+
     @property
     def pyproject_config(self) -> tomlkit.TOMLDocument:
         content = pathlib.Path("pyproject.toml").read_text()
@@ -28,17 +31,16 @@ class BumpVersionPlugin(AutopubPlugin):
         except KeyError:
             config["project"]["version"] = new_version  # type: ignore
 
-    def prepare(self, release_info: ReleaseInfo) -> None:
+    def post_check(self, release_info: ReleaseInfo) -> None:
         config = self.pyproject_config
 
-        version = Version(self._get_version(config))
-
         bump_type = {"major": 0, "minor": 1, "patch": 2}[release_info.release_type]
-        new_version = version.bump(bump_type).serialize()
 
-        self.data["old_version"] = version.serialize()
-        self.data["new_version"] = new_version
+        version = Version(self._get_version(config))
+
+        self.previous_version = str(version)
+        self.new_version = version.bump(bump_type).serialize()
 
-        self._update_version(config, new_version)
+        self._update_version(config, self.new_version)
 
         pathlib.Path("pyproject.toml").write_text(tomlkit.dumps(config))  # type: ignore

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/plugins/git.py

@@ -6,16 +6,18 @@ from autopub.types import ReleaseInfo
 
 class GitPlugin(AutopubPlugin):
     def post_publish(self, release_info: ReleaseInfo) -> None:
-        tag = release_info.additional_info["new_version"]
+        assert release_info.version is not None
+
+        tag_name = release_info.version
 
         self.run_command(["git", "config", "--global", "user.email", "autopub@autopub"])
         self.run_command(["git", "config", "--global", "user.name", "autopub"])
 
-        self.run_command(["git", "tag", tag])
+        self.run_command(["git", "tag", tag_name])
 
         # TODO: config?
         self.run_command(["git", "rm", "RELEASE.md"])
         self.run_command(["git", "add", "--all", "--", ":!main/.autopub"])
         self.run_command(["git", "commit", "-m", "🤖 autopub publish"])
         self.run_command(["git", "push"])
-        self.run_command(["git", "push", "origin", tag])
+        self.run_command(["git", "push", "origin", tag_name])

{autopub-1.0.0a14 → autopub-1.0.0a16}/autopub/plugins/update_changelog.py

@@ -17,8 +17,6 @@ class UpdateChangelogPlugin(AutopubPlugin):
         return Path("CHANGELOG.md")
 
     def post_prepare(self, release_info: ReleaseInfo) -> None:
-        assert release_info.additional_info["new_version"]
-
         if not self.changelog_file.exists():
             self.changelog_file.write_text(f"CHANGELOG\n{CHANGELOG_HEADER}\n\n")
 
@@ -37,7 +35,9 @@ class UpdateChangelogPlugin(AutopubPlugin):
             header = lines[: index + 1]
             break
 
-        new_version = release_info.additional_info["new_version"]
+        new_version = release_info.version
+
+        assert new_version is not None
 
         with self.changelog_file.open("w") as f:
             f.write("\n".join(header))
@@ -48,5 +48,9 @@ class UpdateChangelogPlugin(AutopubPlugin):
             f.write(f"\n{new_version_header}\n")
             f.write(f"{VERSION_HEADER * len(new_version_header)}\n\n")
             f.write(release_info.release_notes)
+
+            for line in release_info.additional_release_notes:
+                f.write(f"\n\n{line}")
+
             f.write("\n")
             f.write("\n".join(old_changelog_data))

autopub-1.0.0a16/autopub/types.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import dataclasses
+from typing import Any
+
+from typing_extensions import Self
+
+
+@dataclasses.dataclass(kw_only=True)
+class ReleaseInfo:
+    """Release information."""
+
+    release_type: str
+    release_notes: str
+    additional_info: dict[str, Any] = dataclasses.field(default_factory=dict)
+    additional_release_notes: list[str] = dataclasses.field(default_factory=list)
+    version: str | None = None
+    previous_version: str | None = None
+
+    def dict(self) -> dict[str, Any]:
+        """Return a dictionary representation of the release info."""
+        return dataclasses.asdict(self)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> Self:
+        return cls(
+            release_type=data["release_type"],
+            release_notes=data["release_notes"],
+            additional_info=data["additional_info"],
+            additional_release_notes=data["additional_release_notes"],
+            version=data["version"],
+            previous_version=data["previous_version"],
+        )

{autopub-1.0.0a14 → autopub-1.0.0a16}/pyproject.toml

@@ -3,7 +3,7 @@ requires-python = ">=3.8"
 
 [tool.poetry]
 name = "autopub"
-version = "1.0.0-alpha.14"
+version = "1.0.0-alpha.16"
 description = "Automatic package release upon pull request merge"
 authors = ["Justin Mayer <entroP@gmail.com>", "Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "AGPL-3.0"
@@ -66,6 +66,7 @@ autopub = "autopub.cli:app"
 
 [tool.poetry.group.dev.dependencies]
 pytest-cov = "^4.1.0"
+pytest-mock = "^3.12.0"
 
 [tool.autopub]
 project-name = "AutoPub"

autopub-1.0.0a14/autopub/types.py

@@ -1,11 +0,0 @@
-import dataclasses
-
-
-@dataclasses.dataclass
-class ReleaseInfo:
-    """Release information."""
-
-    release_type: str
-    release_notes: str
-    additional_info: dict[str, str] = dataclasses.field(default_factory=dict)
-    version: str | None = None