autopub 1.0.0a15__tar.gz → 1.0.0a17__tar.gz

{autopub-1.0.0a15 → autopub-1.0.0a17}/PKG-INFO

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

{autopub-1.0.0a15 → autopub-1.0.0a17}/autopub/__init__.py

@@ -19,11 +19,10 @@ from autopub.exceptions import (
     ReleaseTypeMissing,
 )
 from autopub.plugins import (
-    AutopubBumpVersionPlugin,
     AutopubPackageManagerPlugin,
     AutopubPlugin,
 )
-from autopub.types import ReleaseInfo, ReleaseInfoWithVersion
+from autopub.types import ReleaseInfo
 
 
 class Autopub:
@@ -58,13 +57,9 @@ class Autopub:
         if release_info["hash"] != self.release_file_hash:
             raise ArtifactHashMismatch()
 
-        return ReleaseInfo(
-            release_type=release_info["release_type"],
-            release_notes=release_info["release_notes"],
-            additional_info=release_info["plugin_data"],
-        )
+        return ReleaseInfo.from_dict(release_info)
 
-    def check(self) -> ReleaseInfoWithVersion:
+    def check(self) -> None:
         release_file = Path(self.RELEASE_FILE_PATH)
 
         if not release_file.exists():
@@ -80,25 +75,11 @@ class Autopub:
         for plugin in self.plugins:
             plugin.on_release_notes_valid(release_info)
 
-        version = None
-        previous_version = None
-
         for plugin in self.plugins:
             plugin.post_check(release_info)
 
-            if isinstance(plugin, AutopubBumpVersionPlugin):
-                version = plugin.new_version
-                previous_version = plugin.current_version
-
-        # TODO: raise exception if version is None
-
-        assert version is not None
-        assert previous_version is not None
-
         self._write_artifact(release_info)
 
-        return release_info.with_version(version, previous_version)
-
     def build(self) -> None:
         if not any(
             isinstance(plugin, AutopubPackageManagerPlugin) for plugin in self.plugins
@@ -110,15 +91,15 @@ class Autopub:
                 plugin.build()
 
     def prepare(self) -> None:
-        for plugin in self.plugins:
-            plugin.prepare(self.release_info)
+        release_info = self.release_info
 
-        self._write_artifact(self.release_info)
+        for plugin in self.plugins:
+            plugin.prepare(release_info)
 
         for plugin in self.plugins:
-            plugin.post_prepare(self.release_info)
+            plugin.post_prepare(release_info)
 
-        self._write_artifact(self.release_info)
+        self._write_artifact(release_info)
 
     def _delete_release_file(self) -> None:
         self.release_file.unlink(missing_ok=True)
@@ -138,14 +119,8 @@ 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_info_file.parent.mkdir(exist_ok=True)
@@ -197,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.0a15 → autopub-1.0.0a17}/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.0a15 → autopub-1.0.0a17}/autopub/plugins/__init__.py

@@ -5,7 +5,7 @@ import subprocess
 from typing import Any, Protocol, runtime_checkable
 
 from autopub.exceptions import AutopubException, CommandFailed
-from autopub.types import ReleaseInfo, ReleaseInfoWithVersion
+from autopub.types import ReleaseInfo
 
 
 class AutopubPlugin:
@@ -23,32 +23,25 @@ class AutopubPlugin:
     def prepare(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
-    def post_prepare(
-        self, release_info: ReleaseInfoWithVersion
-    ) -> None:  # pragma: no cover
-        ...
-
-    def validate_release_notes(self, release_info: ReleaseInfo):  # pragma: no cover
+    def post_prepare(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
-    def on_release_notes_valid(self, release_info: ReleaseInfo):  # pragma: no cover
+    def validate_release_notes(
+        self, release_info: ReleaseInfo
+    ) -> None:  # pragma: no cover
         ...
 
-    def on_release_notes_invalid(self, exception: AutopubException):  # pragma: no cover
+    def on_release_notes_valid(
+        self, release_info: ReleaseInfo
+    ) -> None:  # pragma: no cover
         ...
 
-    def post_publish(
-        self, release_info: ReleaseInfoWithVersion
+    def on_release_notes_invalid(
+        self, exception: AutopubException
     ) -> 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
+    def post_publish(self, release_info: ReleaseInfo) -> None:  # pragma: no cover
         ...
 
 

{autopub-1.0.0a15 → autopub-1.0.0a17}/autopub/plugins/bump_version.py

@@ -5,14 +5,11 @@ import pathlib
 import tomlkit
 from dunamai import Version
 
-from autopub.plugins import AutopubBumpVersionPlugin, AutopubPlugin
+from autopub.plugins import AutopubPlugin
 from autopub.types import ReleaseInfo
 
 
-class BumpVersionPlugin(AutopubBumpVersionPlugin, AutopubPlugin):
-    current_version: str
-    new_version: str
-
+class BumpVersionPlugin(AutopubPlugin):
     @property
     def pyproject_config(self) -> tomlkit.TOMLDocument:
         content = pathlib.Path("pyproject.toml").read_text()
@@ -38,9 +35,9 @@ class BumpVersionPlugin(AutopubBumpVersionPlugin, AutopubPlugin):
 
         version = Version(self._get_version(config))
 
-        self.previous_version = str(version)
-        self.new_version = version.bump(bump_type).serialize()
+        release_info.previous_version = str(version)
+        release_info.version = version.bump(bump_type).serialize()
 
-        self._update_version(config, self.new_version)
+        self._update_version(config, release_info.version)
 
         pathlib.Path("pyproject.toml").write_text(tomlkit.dumps(config))  # type: ignore

{autopub-1.0.0a15 → autopub-1.0.0a17}/autopub/plugins/git.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 
 from autopub.plugins import AutopubPlugin
-from autopub.types import ReleaseInfoWithVersion
+from autopub.types import ReleaseInfo
 
 
 class GitPlugin(AutopubPlugin):
-    def post_publish(self, release_info: ReleaseInfoWithVersion) -> None:
+    def post_publish(self, release_info: ReleaseInfo) -> None:
+        assert release_info.version is not None
+
         tag_name = release_info.version
 
         self.run_command(["git", "config", "--global", "user.email", "autopub@autopub"])

{autopub-1.0.0a15 → autopub-1.0.0a17}/autopub/plugins/update_changelog.py

@@ -4,7 +4,7 @@ from datetime import date
 from pathlib import Path
 
 from autopub.plugins import AutopubPlugin
-from autopub.types import ReleaseInfoWithVersion
+from autopub.types import ReleaseInfo
 
 # TODO: from config
 CHANGELOG_HEADER = "========="
@@ -16,7 +16,7 @@ class UpdateChangelogPlugin(AutopubPlugin):
     def changelog_file(self) -> Path:
         return Path("CHANGELOG.md")
 
-    def post_prepare(self, release_info: ReleaseInfoWithVersion) -> None:
+    def post_prepare(self, release_info: ReleaseInfo) -> None:
         if not self.changelog_file.exists():
             self.changelog_file.write_text(f"CHANGELOG\n{CHANGELOG_HEADER}\n\n")
 
@@ -37,6 +37,8 @@ class UpdateChangelogPlugin(AutopubPlugin):
 
         new_version = release_info.version
 
+        assert new_version is not None
+
         with self.changelog_file.open("w") as f:
             f.write("\n".join(header))
             f.write("\n")

autopub-1.0.0a17/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.0a15 → autopub-1.0.0a17}/pyproject.toml

@@ -3,7 +3,7 @@ requires-python = ">=3.8"
 
 [tool.poetry]
 name = "autopub"
-version = "1.0.0-alpha.15"
+version = "1.0.0-alpha.17"
 description = "Automatic package release upon pull request merge"
 authors = ["Justin Mayer <entroP@gmail.com>", "Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "AGPL-3.0"

autopub-1.0.0a15/autopub/types.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-import dataclasses
-
-
-@dataclasses.dataclass(kw_only=True)
-class ReleaseInfo:
-    """Release information."""
-
-    release_type: str
-    release_notes: str
-    additional_info: dict[str, str] = dataclasses.field(default_factory=dict)
-    additional_release_notes: list[str] = dataclasses.field(default_factory=list)
-
-    def with_version(
-        self, version: str, previous_version: str
-    ) -> ReleaseInfoWithVersion:
-        """Return a new ReleaseInfoWithVersion instance."""
-        return ReleaseInfoWithVersion(
-            release_type=self.release_type,
-            release_notes=self.release_notes,
-            additional_info=self.additional_info,
-            version=version,
-            previous_version=previous_version,
-        )
-
-
-@dataclasses.dataclass(kw_only=True)
-class ReleaseInfoWithVersion(ReleaseInfo):
-    """Release information with version."""
-
-    version: str
-    previous_version: str