Restructure and clean up GitHub release notes generator

Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>

Author: NotTheEvilOne

poetry.lock

@@ -21,7 +21,7 @@ pygit2 = "^1.19.1"
 pygments = "^2.19.2"
 PyGithub = "^2.8.1"
 PyYAML = "^6.0.2"
-gitpython = "^3.1.45"
+semver = "^3.0.4"
 
 [tool.poetry.group.dev.dependencies]
 bandit = "^1.9.3"

pyproject.toml

@@ -145,6 +145,7 @@
 
 GL_BUG_REPORT_URL = "https://github.com/gardenlinux/gardenlinux/issues"
 GL_COMMIT_SPECIAL_VALUES = ("local",)
+GL_CONTAINER_REGISTRY_BASE_URL = "ghcr.io/gardenlinux/gardenlinux"
 GL_DEB_REPO_BASE_URL = "https://packages.gardenlinux.io/gardenlinux"
 GL_DISTRIBUTION_NAME = "Garden Linux"
 GL_HOME_URL = "https://gardenlinux.io"
@@ -157,8 +158,6 @@
 OCI_ANNOTATION_SIGNED_STRING_KEY = "io.gardenlinux.oci.signed-string"
 OCI_IMAGE_INDEX_MEDIA_TYPE = "application/vnd.oci.image.index.v1+json"
 
-RELEASE_ID_FILE = ".github_release_id"
-
 REQUESTS_TIMEOUTS = (5, 60)  # connect, read
 
 S3_DOWNLOADS_DIR = Path(os.path.dirname(__file__)) / ".." / "s3_downloads"
@@ -167,7 +166,3 @@
 GLVD_BASE_URL = "https://security.gardenlinux.org/v1"
 
 PODMAN_CONNECTION_MAX_IDLE_SECONDS = 3
-
-# https://github.com/gardenlinux/gardenlinux/issues/3044
-# Empty string is the 'legacy' variant with traditional root fs and still needed/supported
-IMAGE_VARIANTS = ["", "_usi", "_tpm2_trustedboot"]

src/gardenlinux/constants.py

@@ -0,0 +1,63 @@
+from semver import Version
+
+
+class UnsupportedDistroVersion(Exception):
+    pass
+
+
+class NotAPatchRelease(Exception):
+    pass
+
+
+class DistroVersion(Version):  # type: ignore[misc]
+    def __init__(self, version: str | Version):
+        self._version_format_without_patch_number = False
+
+        try:
+            if isinstance(version, Version):
+                version_parsed = version
+            elif len(version.split(".")) == 2:
+                # Support version strings without patch numbers
+                version_parsed = Version.parse(f"{version}.0")
+                self._version_format_without_patch_number = True
+            else:
+                version_parsed = Version.parse(version)
+        except Exception as exc:
+            raise UnsupportedDistroVersion(exc)
+
+        Version.__init__(
+            self,
+            version_parsed.major,
+            version_parsed.minor,
+            version_parsed.patch,
+            version_parsed.prerelease,
+            version_parsed.build,
+        )
+
+    @property
+    def is_patch_release(self) -> bool:
+        if self._version_format_without_patch_number:
+            return self.minor > 0  # type: ignore[no-any-return]
+
+        return self.patch > 0  # type: ignore[no-any-return]
+
+    @property
+    def previous_patch_release(self) -> str:
+        if not self.is_patch_release:
+            raise NotAPatchRelease(f"{self} is not a patch release")
+
+        if self._version_format_without_patch_number:
+            previous_version = DistroVersion(
+                Version(self.major, self.minor - 1, self.patch)
+            )
+            return f"{previous_version.major}.{previous_version.minor}"
+
+        return str(
+            Version(
+                self.major,
+                self.minor,
+                self.patch - 1,
+                prerelease=self.prerelease,
+                build=self.build,
+            )
+        )

src/gardenlinux/distro_version.py

@@ -1,21 +1,5 @@
-import logging
-import sys
-
-from ...constants import RELEASE_ID_FILE
-from ...logger import LoggerSetup
+from .deployment_platform import DeploymentPlatform
 from .release import Release
+from .release_images_metadata import ReleaseImagesMetadata
 
-LOGGER = LoggerSetup.get_logger("gardenlinux.github.release", logging.INFO)
-
-
-def write_to_release_id_file(release_id: str | int) -> None:
-    try:
-        with open(RELEASE_ID_FILE, "w") as file:
-            file.write(str(release_id))
-        LOGGER.info(f"Created {RELEASE_ID_FILE} successfully.")
-    except IOError as e:
-        LOGGER.error(f"Could not create {RELEASE_ID_FILE} file: {e}")
-        sys.exit(1)
-
-
-__all__ = ["Release", "write_to_release_id_file"]
+__all__ = ["DeploymentPlatform", "Release", "ReleaseImagesMetadata"]

src/gardenlinux/distro_version/__init__.py

@@ -4,8 +4,7 @@
 from gardenlinux.constants import GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
 from gardenlinux.logger import LoggerSetup
 
-from ..release_notes import create_github_release_notes
-from . import write_to_release_id_file
+from .notes import MarkdownGenerator
 from .release import Release
 
 LOGGER = LoggerSetup.get_logger("gardenlinux.github", logging.INFO)
@@ -167,24 +166,24 @@ def main() -> None:
         release.is_latest = args.latest
         release.create()
     elif args.command == "create-with-gl-release-notes":
-        body = create_github_release_notes(
-            args.tag, args.commit, GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
-        )
+        release = Release(args.repo, args.owner)
+        release.tag = args.tag
+        release.commitish = args.commit
+        release.is_latest = args.latest
+
+        generator = MarkdownGenerator(release, GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME)
 
         if args.dry_run:
             print("Dry Run ...")
             print("This release would be created:")
-            print(body)
+            print(str(generator))
         else:
-            release = Release(args.repo, args.owner)
-            release.tag = args.tag
-            release.body = body
-            release.commitish = args.commit
-            release.is_latest = args.latest
+            release.body = str(generator)
 
             release_id = release.create()
-            write_to_release_id_file(f"{release_id}")
             LOGGER.info(f"Release created with ID: {release_id}")
+
+            print(f"{release_id}")
     elif args.command == "upload":
         release = Release.get(args.release_id, repo=args.repo, owner=args.owner)
 

src/gardenlinux/github/release/__init__.py

@@ -0,0 +1,8 @@
+{
+    "short_name": "ali",
+    "full_name": "Alibaba Cloud",
+    "image_extension": "qcow2",
+
+    "mapping_type": "regions_list",
+    "mapping_entry_json": "{\"region\": \"{region_id}\", \"image_id\": \"{image_id}\"}"
+}

src/gardenlinux/github/release/__main__.py

@@ -0,0 +1,8 @@
+{
+    "short_name": "aws",
+    "full_name": "Amazon Web Services",
+    "image_extension": "raw",
+
+    "mapping_type": "regions_list",
+    "mapping_entry_json": "{\"region\": \"{aws_region_id}\", \"image_id\": \"{ami_id}\"}"
+}

src/gardenlinux/github/release/ali_cloud.platform.json

@@ -0,0 +1,8 @@
+{
+    "short_name": "azure",
+    "full_name": "Microsoft Azure",
+    "image_extension": "vhd",
+
+    "mapping_type": "azure_gallery_and_marketplace_list",
+    "mapping_entry_json": "{\"hyper_v_generation\": \"{hyper_v_generation}\", \"azure_cloud\": \"{azure_cloud}\", \"image_id\": \"{community_gallery_image_id}\", \"urn\": \"{urn}\"}"
+}