Add support to create pre-releases with a generated changelog

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

Author: NotTheEvilOne

.github/actions/features_parse/action.yml

@@ -11,7 +11,7 @@ outputs:
 runs:
   using: composite
   steps:
-    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.8
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.9
     - id: result
       shell: bash
       run: |

.github/actions/flavors_parse/action.yml

@@ -13,7 +13,7 @@ outputs:
 runs:
   using: composite
   steps:
-    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.8
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.9
     - id: matrix
       shell: bash
       run: |

.github/actions/setup/action.yml

@@ -4,7 +4,7 @@ description: Installs the given GardenLinux Python library
 inputs:
   version:
     description: GardenLinux Python library version
-    default: "0.10.8"
+    default: "0.10.9"
   python_version:
     description: Python version to setup
     default: "3.13"

.github/workflows/release.yml

@@ -0,0 +1,51 @@
+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
+      with:
+        sparse-checkout: |
+          cliff.toml
+        sparse-checkout-cone-mode: false
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@main
+      with:
+        version: 1.0.0-pre1
+    - name: Use cargo cache
+      id: cache-cargo
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cargo
+        key: gh-release-${{ runner.os }}-cargo-${{ hashFiles('~/.cargo/.crates.toml') }}
+        restore-keys: gh-release-${{ runner.os }}-cargo-
+    - name: Install git-cliff
+      if: steps.cache-cargo.outputs.cache-hit != 'true'
+      run: |
+        cargo install git-cliff
+    - 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: |
+        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 }}' \
+         --latest \
+         --body "
+         $(git-cliff -o - --current)
+         "

poetry.lock

@@ -1,30 +1,31 @@
 [tool.poetry]
 name = "gardenlinux"
-version = "0.10.8"
+version = "0.10.9"
 description = "Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames"
 authors = ["Garden Linux Maintainers <contact@gardenlinux.io>"]
 license = "Apache-2.0"
 readme = "README.md"
 packages = [{ include = "gardenlinux", from = "src" }]
 
 [tool.poetry.dependencies]
-python = ">=3.13, <3.14"
+python = ">=3.13,!=3.14.1"
 apt-repo = "^0.5"
-boto3 = "^1.42.10"
+boto3 = "^1.42.30"
 click = "^8.3.1"
 cryptography = "^46.0.3"
-jsonschema = "^4.25.1"
+jsonschema = "^4.26.0"
 networkx = "^3.6"
 oras = "^0.2.38"
-pygit2 = "^1.19.0"
+pygit2 = "^1.19.1"
 pygments = "^2.19.2"
+PyGithub = "^2.8.1"
 PyYAML = "^6.0.2"
 gitpython = "^3.1.45"
 
 [tool.poetry.group.dev.dependencies]
-bandit = "^1.9.2"
-moto = "^5.1.16"
-pre-commit = "^4.5.0"
+bandit = "^1.9.3"
+moto = "^5.1.20"
+pre-commit = "^4.5.1"
 python-dotenv = "^1.2.1"
 pytest = "^9.0.2"
 pytest-cov = "^7.0.0"
@@ -34,7 +35,7 @@ mypy = "1.18.2"
 types-click = "^7.1.8"
 types-pyyaml = "^6.0.12.20250915"
 types-requests = "^2.32.4.20260107"
-boto3-stubs = { extras = ["s3"], version = "^1.42.25" }
+boto3-stubs = { extras = ["s3"], version = "^1.42.30" }
 
 [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

@@ -5,8 +5,9 @@
 
 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", logging.INFO)
 
@@ -103,3 +104,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

@@ -6,10 +6,10 @@
 
 from ..release_notes import create_github_release_notes
 from . import (
-    create_github_release,
     upload_to_github_release_page,
     write_to_release_id_file,
 )
+from .release import Release
 
 LOGGER = LoggerSetup.get_logger("gardenlinux.github", logging.INFO)
 
@@ -22,9 +22,19 @@ def main() -> None:
     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")
@@ -36,6 +46,15 @@ def main() -> None:
     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
         )
@@ -44,9 +63,13 @@ def main() -> None:
             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":