feat: Update client builder

Author: ewuerger

.commitlintrc.yml

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG
+# SPDX-License-Identifier: CC0-1.0
+
+extends:
+  - '@commitlint/config-conventional'
+rules:
+  body-leading-blank: [2, always]
+  footer-leading-blank: [2, always]
+  scope-case: [2, always, lower-case]
+  subject-case: [2, always, sentence-case]
+  subject-empty: [2, never]
+  subject-full-stop: [2, never, .]
+  subject-max-length: [2, always, 72]
+  type-empty: [2, never]
+  type-enum: [2, always, [
+      build,
+      chore,
+      ci,
+      docs,
+      feat,
+      fix,
+      merge,
+      perf,
+      refactor,
+      revert,
+      test,
+    ]]

.github/workflows/build-test-publish.yml

@@ -4,10 +4,15 @@
 name: Build
 
 on:
+  pull_request:
   push:
     branches: ["*"]
-    pull_request: [main]
     tags: ["v*.*.*"]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_type == 'tag' && github.sha || '0' }}
+  cancel-in-progress: true
 
 jobs:
   test:
@@ -21,55 +26,58 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
+          - "3.13"
         include:
           - os: windows-latest
             python_version: "3.12"
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python ${{matrix.python_version}}
-        uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v5
         with:
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
           python-version: ${{matrix.python_version}}
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{runner.os}}-pip-${{hashFiles('pyproject.toml')}}
-          restore-keys: |
-            ${{runner.os}}-pip-
-            ${{runner.os}}-
-      - name: Upgrade Pip
-        run: |-
-          python -m pip install -U pip
-      - name: Install test dependencies
-        run: |-
-          python -m pip install '.[test]'
       - name: Run unit tests
-        run: |-
-          python -m pytest --cov-report=term --cov=polarion_rest_api_client --rootdir=.
+        run: uv run coverage run
+      - name: Report coverage
+        if: always()
+        run: uv run coverage report
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+          python-version: "3.13"
+      - name: Run Pre-Commit
+        run: uv run pre-commit run --all-files
+
   build:
     name: Build wheel
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         with:
-          cache: pip
-          cache-dependency-path: pyproject.toml
-          python-version: "3.12"
-      - name: Install dependencies
-        run: python -m pip install -U pip build twine
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+          python-version: "3.13"
       - name: Build packages
-        run: python -m build
+        run: uv build --no-sources
       - name: Verify packages
-        run: python -m twine check dist/*
+        run: uvx twine check dist/*
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: python-package-distributions
-          path: dist/
+          path: 'dist/*'
           if-no-files-found: error
   pypi:
     name: Publish to PyPI

.github/workflows/docs.yml

@@ -4,8 +4,10 @@
 name: Docs
 
 on:
+  pull_request:
   push:
     branches: ["main"]
+  workflow_dispatch:
 
 jobs:
   sphinx:
@@ -16,23 +18,25 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         with:
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
           python-version: "3.12"
-      - name: Upgrade pip
-        run: |
-          python -m pip install -U pip
-      - name: Install dependencies
-        run: |
-          python -m pip install '.[docs]'
-      - name: Auto-generate APIDOC sources
-        run: |-
-          sphinx-apidoc --output-dir docs/source/code --force . polarion_rest_api_client/open_api_client
+      - name: Install system-level dependencies
+        run: sudo apt-get install -y pandoc
       - name: Create docs
-        run: |
-          make -C docs html
+        run: make -C docs html
+      - name: Upload built docs as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation
+          path: docs/build/html
+          if-no-files-found: error
+          retention-days: 5
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v4
         with:
           force_orphan: true
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -3,7 +3,7 @@
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[cod]
+*.py[codz]
 *$py.class
 
 # C extensions
@@ -52,7 +52,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
+*.py.cover
 .hypothesis/
 .pytest_cache/
 cover/
@@ -102,20 +102,35 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
 #poetry.lock
+#poetry.toml
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
 #pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
@@ -129,6 +144,7 @@ celerybeat.pid
 
 # Environments
 .env
+.envrc
 .venv
 env/
 venv/
@@ -140,9 +156,6 @@ venv.bak/
 .spyderproject
 .spyproject
 
-# VS Code settings
-.vscode/
-
 # Rope project settings
 .ropeproject
 
@@ -162,3 +175,9 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc