Merge pull request #129 from OpenSemanticLab/uv-zensical-migration

Migrate repository structure, tooling, CI/CD and docs to the uv zensical stack

Author: raederan

.coveragerc

@@ -0,0 +1,30 @@
+name: "Setup Python Environment"
+description: "Set up Python and uv, then install the locked dependencies"
+
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: true
+    default: "3.12"
+  uv-version:
+    description: "uv version to use"
+    required: true
+    default: "0.9.9"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: true
+        cache-suffix: ${{ matrix.python-version }}
+
+    - name: Install Python dependencies
+      run: uv sync --frozen
+      shell: bash

.github/actions/setup-python-env/action.yml

@@ -1,31 +1,41 @@
-# This is a basic workflow to help you get started with Actions
+# Deploys the documentation with mike (versioned docs on the gh-pages
+# branch; repo setting: Pages source = "Deploy from a branch: gh-pages").
+#
+# push to main        -> version "dev"
+# tag vX.Y.Z          -> version "X.Y.Z" + "latest" alias (on-release-main.yml)
 
 name: Docs
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [ main ]
-
-  # Allows you to run this workflow manually from the Actions tab
+    branches: [main]
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+permissions:
+  # mike commits the built site to the gh-pages branch
+  contents: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
+  deploy-docs:
     runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - name: Check out
+        uses: actions/checkout@v4
         with:
+          # deep clone incl. tags: hatch-vcs needs them and mike needs gh-pages
           fetch-depth: 0
-      - uses: actions/setup-python@v2
-      - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files "mkdocstrings[python]" mkdocs-material
-      - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
-      - name: Publish docs
-        run: mkdocs gh-deploy
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Configure git identity
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: Deploy dev documentation
+        run: uv run mike deploy --push dev

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+# Integration tests against a live test wiki. Credentials come from the
+# INTEGR_TEST_* secrets; where they are unavailable (e.g. forks), the
+# credential fixtures make the tests skip instead of fail.
+#
+# Runs on every pull request into main, so breaking changes surface before the
+# release job (gated separately by required review on the pypi environment)
+# ever starts. No push trigger: a push to main is already covered by the PR
+# that preceded it, so a second run would add nothing.
+
+name: Integration
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  # runs mutate the shared test wiki, so never run two in parallel
+  group: integration
+  cancel-in-progress: false
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+        with:
+          # deep clone incl. tags so hatch-vcs can derive the version
+          fetch-depth: 0
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Run integration tests
+        env:
+          WIKI_DOMAIN: ${{ secrets.INTEGR_TEST_WIKI_DOMAIN }}
+          WIKI_USERNAME: ${{ secrets.INTEGR_TEST_WIKI_USERNAME }}
+          WIKI_PASSWORD: ${{ secrets.INTEGR_TEST_WIKI_PASSWORD }}
+        run: make test-integration