Add support to create pre-releases with a generated changelog

Signed-off-by: Tobias Wolf <[email protected]>
On-behalf-of: SAP <[email protected]>

Author: NotTheEvilOne

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: pre-release
+
+on:
+  push:
+    tags: [ "[0-9]+.[0-9]+.[0-9]+*" ]
+
+jobs:
+  create-pre-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout commit
+      uses: actions/checkout@v6
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@main
+      with:
+        version: 1.0.0-pre1
+    - name: Use cargo cache
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cargo
+        save-always: true
+        key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }}
+        restore-keys: ${{ runner.os }}-cargo-
+    - name: Get the Git tag name
+      id: get-tag-name
+      run: echo "tag-name=${GITHUB_REF/refs\/tags\//}" | tee -a "$GITHUB_OUTPUT"
+    - id: release
+      name: Create changelog and release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        cargo update --recursive git-cliff
+
+        gl-gh-release create \
+         --repo "python-gardenlinux-lib" \
+         --tag "${{ steps.get-tag-name.outputs.tag-name }}" \
+         --commit "${{ github.sha }}" \
+         --name 'python-gardenlinux-lib v${{ steps.get-tag-name.outputs.tag-name }}' \
+         --body "
+         Changes for v${{ steps.get-tag-name.outputs.tag-name }}
+
+         $(git-cliff -o - --current --topo-order")
+         "

poetry.lock

@@ -10,14 +10,15 @@ packages = [{ include = "gardenlinux", from = "src" }]
 [tool.poetry.dependencies]
 python = ">=3.13"
 apt-repo = "^0.5"
-boto3 = "^1.40.57"
+boto3 = "^1.41.5"
 click = "^8.2.1"
 cryptography = "^46.0.1"
 jsonschema = "^4.25.1"
 networkx = "^3.5"
 oras = "^0.2.38"
 pygit2 = "^1.19.0"
 pygments = "^2.19.2"
+PyGithub = "^2.8.1"
 PyYAML = "^6.0.2"
 gitpython = "^3.1.45"
 
@@ -26,11 +27,11 @@ bandit = "^1.8.6"
 black = "^25.1.0"
 moto = "^5.1.12"
 python-dotenv = "^1.1.1"
-pytest = "^9.0.0"
+pytest = "^9.0.1"
 pytest-cov = "^7.0.0"
 isort = "^7.0.0"
 requests-mock = "^1.12.1"
-pyright = "^1.1.403"
+pyright = "^1.1.407"
 
 [tool.poetry.group.docs.dependencies]
 sphinx-rtd-theme = "^3.0.2"

pyproject.toml

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+"""
+GitHub module
+"""
+
+from .client import Client
+
+__all__ = ["Client"]

src/gardenlinux/github/__init__.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+
+"""
+GitHub client
+"""
+
+from logging import Logger
+from os import environ
+from typing import Any, Optional
+
+from github import Auth, Github
+
+from ..logger import LoggerSetup
+
+
+class Client(object):
+    """
+    GitHub client instance to provide methods for interaction with GitHub API.
+
+    :author:     Garden Linux Maintainers
+    :copyright:  Copyright 2024 SAP SE
+    :package:    gardenlinux
+    :subpackage: github
+    :since:      1.0.0
+    :license:    https://www.apache.org/licenses/LICENSE-2.0
+                 Apache License, Version 2.0
+    """
+
+    def __init__(self, token: Optional[str] = None, logger: Optional[Logger] = None):
+        """
+        Constructor __init__(Client)
+
+        :param token: GitHub access token
+        :param logger: Logger instance
+
+        :since: 1.0.0
+        """
+
+        self._client = None
+        self._token = token
+
+        if self._token is None or self._token.strip() == "":
+            self._token = environ.get("GITHUB_TOKEN")
+
+        if self._token is None:
+            raise ValueError("GITHUB_TOKEN environment variable not set")
+
+        if logger is None or not logger.hasHandlers():
+            logger = LoggerSetup.get_logger("gardenlinux.github")
+
+        self._logger = logger
+
+    @property
+    def instance(self) -> Github:
+        if self._client is None:
+            self._client = Github(auth=Auth.Token(self._token))
+
+        return self._client
+
+    def __getattr__(self, name: str) -> Any:
+        """
+        python.org: Called when an attribute lookup has not found the attribute in
+        the usual places (i.e. it is not an instance attribute nor is it found in the
+        class tree for self).
+
+        :param name: Attribute name
+
+        :return: (mixed) Attribute
+        :since:  0.8.0
+        """
+
+        self._logger.debug(f"gardenlinux.github.Client.{name} accessed")
+        return getattr(self.instance, name)

src/gardenlinux/github/client.py

@@ -1,52 +1,15 @@
-import json
 import os
 import sys
 
 import requests
 
-from gardenlinux.constants import RELEASE_ID_FILE, REQUESTS_TIMEOUTS
-from gardenlinux.logger import LoggerSetup
+from ...constants import RELEASE_ID_FILE, REQUESTS_TIMEOUTS
+from ...logger import LoggerSetup
+from .release import Release
 
 LOGGER = LoggerSetup.get_logger("gardenlinux.github.release", "INFO")
 
 
-def create_github_release(owner, repo, tag, commitish, latest, body):
-    token = os.environ.get("GITHUB_TOKEN")
-    if not token:
-        raise ValueError("GITHUB_TOKEN environment variable not set")
-
-    headers = {
-        "Authorization": f"token {token}",
-        "Accept": "application/vnd.github.v3+json",
-    }
-
-    data = {
-        "tag_name": tag,
-        "target_commitish": commitish,
-        "name": tag,
-        "body": body,
-        "draft": False,
-        "prerelease": False,
-        "make_latest": "true" if latest else "false",
-    }
-
-    response = requests.post(
-        f"https://api.github.com/repos/{owner}/{repo}/releases",
-        headers=headers,
-        data=json.dumps(data),
-        timeout=REQUESTS_TIMEOUTS,
-    )
-
-    if response.status_code == 201:
-        LOGGER.info("Release created successfully")
-        response_json = response.json()
-        return response_json.get("id")
-    else:
-        LOGGER.error("Failed to create release")
-        LOGGER.debug(response.json())
-        response.raise_for_status()
-
-
 def write_to_release_id_file(release_id):
     try:
         with open(RELEASE_ID_FILE, "w") as file:
@@ -94,3 +57,6 @@ def upload_to_github_release_page(
             f"Upload failed with status code {response.status_code}: {response.text}"
         )
         response.raise_for_status()
+
+
+__all__ = ["Release", "write_to_release_id_file", "upload_to_github_release_page"]

src/gardenlinux/github/release/__init__.py

@@ -3,12 +3,12 @@
 from gardenlinux.constants import GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
 from gardenlinux.logger import LoggerSetup
 
-from .release import (
-    create_github_release,
+from ..release_notes import create_github_release_notes
+from . import (
     upload_to_github_release_page,
     write_to_release_id_file,
 )
-from ..release_notes import create_github_release_notes
+from .release import Release
 
 LOGGER = LoggerSetup.get_logger("gardenlinux.github", "INFO")
 
@@ -21,9 +21,19 @@ def main():
     create_parser.add_argument("--owner", default="gardenlinux")
     create_parser.add_argument("--repo", default="gardenlinux")
     create_parser.add_argument("--tag", required=True)
-    create_parser.add_argument("--commit", required=True)
+    create_parser.add_argument("--name")
+    create_parser.add_argument("--body", required=True)
+    create_parser.add_argument("--commit")
+    create_parser.add_argument("--pre-release", action="store_true", default=True)
     create_parser.add_argument("--latest", action="store_true", default=False)
-    create_parser.add_argument("--dry-run", action="store_true", default=False)
+
+    create_parser_gl = subparsers.add_parser("create-with-gl-release-notes")
+    create_parser_gl.add_argument("--owner", default="gardenlinux")
+    create_parser_gl.add_argument("--repo", default="gardenlinux")
+    create_parser_gl.add_argument("--tag", required=True)
+    create_parser_gl.add_argument("--commit", required=True)
+    create_parser_gl.add_argument("--latest", action="store_true", default=False)
+    create_parser_gl.add_argument("--dry-run", action="store_true", default=False)
 
     upload_parser = subparsers.add_parser("upload")
     upload_parser.add_argument("--owner", default="gardenlinux")
@@ -35,6 +45,15 @@ def main():
     args = parser.parse_args()
 
     if args.command == "create":
+        release = Release(args.repo, args.owner)
+        release.tag = args.tag
+        release.name = args.name
+        release.body = args.body
+        release.commit_hash = args.commit
+        release.is_pre_release = args.pre_release
+        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
         )
@@ -43,9 +62,13 @@ def main():
             print("This release would be created:")
             print(body)
         else:
-            release_id = create_github_release(
-                args.owner, args.repo, args.tag, args.commit, args.latest, body
-            )
+            release = Release(args.repo, args.owner)
+            release.tag = args.tag
+            release.body = body
+            release.commit_hash = args.commit
+            release.is_latest = args.latest
+
+            release_id = release.create()
             write_to_release_id_file(f"{release_id}")
             LOGGER.info(f"Release created with ID: {release_id}")
     elif args.command == "upload":