feat: implemented release automation (#154)

bensteUEM · bensteUEM · commit 5496625d1d1e · 2025-05-17T21:44:16.000+02:00
diff --git a/.github/workflows/python-unittest.yml b/.github/workflows/python-unittest.yml
@@ -1,6 +1,10 @@
 name: Python Tests ChurchToolsAPI
 
-on: [ push, pull_request ]
+on: 
+  push:
+    branches-ignore:
+      - main
+  pull_request:
 
 env:
   CT_TOKEN: ${{ secrets.CT_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,56 +1,104 @@
-name: Create Release
+name: 1. Release-Please
+
 on:
   push:
-    tags:
-      - '*'
-          
+    branches:
+      - main
+permissions:
+  contents: write
+  pull-requests: write  
+
 jobs:
-  build:
+  release-please:
     runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+          token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+
+      - name: Debug release outputs
+        run: |
+          echo "release_created=${{ steps.release.outputs.release_created }}"
+          echo "version=${{ steps.release.outputs.version }}"
+          echo "tag_name=${{ steps.release.outputs.tag_name }}"
+          echo "upload_url=${{ steps.release.outputs.upload_url }}"
+          
       - name: Checkout code
+        if: ${{ steps.release.outputs.release_created }}
         uses: actions/checkout@v4.2.1
 
-      - name: Version from Python
-        run: echo "VERSION=$(python3 -c 'import version; print(version.VERSION)')" >> $GITHUB_ENV
+      - name: last release tag
+        if: ${{ steps.release.outputs.release_created }}
+        id: get_last_release
+        run: |
+          LAST_RELEASE_TAG=$(gh release list --limit 2 --json tagName -q '.[1].tagName') 
+          echo "last_release=$LAST_RELEASE_TAG"
+          echo "last_release=$LAST_RELEASE_TAG" >> $GITHUB_OUTPUT
 
       - name: Set up Python
+        if: ${{ steps.release.outputs.release_created }}
         uses: actions/setup-python@v5.2.0
         with:
           python-version: 3.x
 
       - name: Install Poetry
+        if: ${{ steps.release.outputs.release_created }}
         run: |
           pip install poetry
           poetry config virtualenvs.create false  # Skip creating a virtual environment
         env:
           POETRY_HOME: ${{ github.workspace }}/.poetry
 
       - name: Install project dependencies
-        run: |
-          poetry install
+        if: ${{ steps.release.outputs.release_created }}
+        run: poetry install
         env:
           POETRY_HOME: ${{ github.workspace }}/.poetry
 
       - name: Build package
-        run: |
-          poetry build
+        if: ${{ steps.release.outputs.release_created }}
+        run: poetry build
         env:
           POETRY_HOME: ${{ github.workspace }}/.poetry
 
-      - name: Create Release
-        uses: ncipollo/release-action@v1.14.0
-        with:
-          tag: ${{ env.VERSION}}
-          name: Version ${{env.VERSION}}
-          body: |
-            Automated Release preparation using Git Tag
-            - make sure tests didn't fail
-            - needs to be published from draft online
-            
-            Install as package using:
-            pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@${{env.VERSION}}#egg=churchtools-api
-            
-          draft: true
-          prerelease: false
-          artifacts: dist/*
+      - name: Append custom release notes
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          release_id=$(gh api \
+            -H "Accept: application/vnd.github+json" \
+            /repos/${{ github.repository }}/releases/tags/${{ steps.release.outputs.tag_name }} \
+            --jq .id)
+
+          # Fetch existing release body
+          existing_body=$(gh api /repos/${{ github.repository }}/releases/$release_id --jq .body)
+
+          # Create temporary file for new body
+          tmpfile=$(mktemp)
+
+          # Write combined content into the file
+          {
+            echo "$existing_body"
+            echo
+            echo "Install as package using:"
+            echo '```bash'
+            echo "pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@${{ steps.release.outputs.tag_name }}#egg=churchtools-api"
+            echo '```'
+            echo "**Full Changelog**: https://github.com/bensteUEM/ChurchToolsAPI/compare/${{ steps.get_last_release.outputs.last_release }}...${{ steps.release.outputs.tag_name }}"
+          } > "$tmpfile"
+
+          # Update the release body using the file
+          gh api \
+            -X PATCH \
+            -H "Accept: application/vnd.github+json" \
+            /repos/${{ github.repository }}/releases/$release_id \
+            -F body="$(cat "$tmpfile")"
+
+      - name: Upload Release Artifact
+        if: ${{ steps.release.outputs.release_created }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload ${{ steps.release.outputs.tag_name }} dist/*
diff --git a/churchtools_api/churchtools_api_abstract.py b/churchtools_api/churchtools_api_abstract.py
@@ -3,6 +3,10 @@
 import json
 import logging
 from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import requests
 
 logger = logging.getLogger(__name__)
 
@@ -17,8 +21,8 @@ class ChurchToolsApiAbstract(ABC):
     @abstractmethod
     def __init__(self) -> None:
         """Preparing base variables."""
-        self.session = None
-        self.domain = None
+        self.session:requests.Session |None = None
+        self.domain:str|None = None
 
     def combine_paginated_response_data(
         self,
diff --git a/generate_pyproj.py b/generate_pyproj.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,11 +2,7 @@
 name = "churchtools-api"
 version = "1.7.3"
 description = "A python wrapper for use with ChurchToolsAPI"
-authors = [
-    "bensteUEM",
-    "kolibri52",
-    "fschrempf",
-]
+authors = ["bensteUEM", "kolibri52", "fschrempf"]
 homepage = "https://github.com/bensteUEM/ChurchToolsAPI"
 license = "CC-BY-SA"
 readme = "README.md"
@@ -64,28 +60,23 @@ target-version = "py310"
 output-format = "grouped"
 
 [tool.ruff.lint]
-select = [
-    "ALL",
-]
+select = ["ALL"]
 ignore = [
     "FIX002", # correctly formatted TODO items that have open Github issues        
-    "COM812", "ISC001", #disabled for formatter compatibility #TODO 102 - move to pyproject.py
+    "COM812",
+    "ISC001", #disabled for formatter compatibility #TODO 102 - move to pyproject.py
 
     "N802", #function lowercase -> breaking change #TODO 125 with release 2.0
     "N803", #argument lowercase -> breaking change #TODO 125 with release 2.0
     "N806", #variable name lowercase -> breaking change #TODO 125 with release 2.0
-    ]
-
-fixable = [
-    "ALL",
 ]
+
+fixable = ["ALL"]
 unfixable = []
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*.py" = [
-    "S101",
-]
+"tests/*.py" = ["S101"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
@@ -99,7 +90,5 @@ docstring-code-format = false
 docstring-code-line-length = "dynamic"
 
 [build-system]
-requires = [
-    "poetry-core",
-]
+requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
diff --git a/version.py b/version.py
