Rework GitHub workflows (#46)

* Rework docs workflow

* Fix docs workflow

* Remove uncessary permissions from ruff workflow

* rework test workflow

* Rework release workflow

* merge docs and pypi workflow into build

* enable cache and improve naming

* split dist in dist and dist-release

* seperate publishing action in seperated release workflow

Author: Luc1412

.github/workflows/build.yml

@@ -0,0 +1,48 @@
+name: build
+
+on:
+  push:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+  release:
+    types: [ published ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --extra docs
+      - name: Build documentation
+        run: |
+          cd docs
+          uv run sphinx-build -b html -j auto -a -n -T -W --keep-going . _build/html
+  dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync
+      - name: Build distributions
+        run: uv build

.github/workflows/docs.yml

@@ -10,17 +10,16 @@ permissions:
 
 jobs:
   ruff:
-    permissions:
-      contents: read
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
 
-      - name: Get Ruff Version
+      - name: Get Ruff version
         id: ruff-version
         run: echo "version=$(grep -Po '(?<=ruff==)[0-9]+\.[0-9]+\.[0-9]+' pyproject.toml)" >> $GITHUB_OUTPUT
-  
-      - uses: astral-sh/ruff-action@v3
+
+      - name: Run Ruff linter
+        uses: astral-sh/ruff-action@v3
         with:
           version: ${{ steps.ruff-version.outputs.version }}
   pyright:

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: release
+
+on:
+  release:
+    types: [ published ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  dist:
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fortnite-api
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - name: Setup UV
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync
+      - name: Build distributions
+        run: uv build
+      - name: Publish distributions
+        run: uv publish

.github/workflows/pypi.yml

@@ -1,7 +1,7 @@
 # This workflow will ensure that the pushed contents to the repo
 # are not majorly breaking.
 
-name: Pytests
+name: test
 
 on:
   push:
@@ -14,27 +14,26 @@ permissions:
 
 jobs:
   pytest:
-    name: Pytest
     runs-on: ubuntu-latest
-
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ '3.10', '3.x' ]
+    name: pytest ${{ matrix.python-version }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-
-      - name: Setup Python 3.10
+      - uses: actions/checkout@v5
+      - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v6
         with:
-          python-version: "3.10"
+          python-version: ${{ matrix.python-version }}
           cache: "pip" # Cache the pip packages to speed up the workflow
-
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
       - name: Install Dependencies and Package
-        run: |
-          python -m pip install -U pip setuptools
-          pip install -U -r requirements.txt
-          pip install -e .[tests]
-
+        run: uv sync --extra tests
       - name: Run Pytest Checks
-        shell: bash
         env:
           TEST_API_KEY: ${{ secrets.TEST_API_KEY }}
-        run: python -m pytest --cov=fortnite_api --import-mode=importlib -vs tests/
+        run: uv run pytest --cov=fortnite_api --import-mode=importlib -vs tests/