Update documentation and workflows

Author: Blupo

.github/workflows/build-dev.yml renamed to .github/workflows/dev-build.yml

@@ -6,7 +6,9 @@ on:
       - develop
     paths-ignore:
       - "docs/**"
-  workflow_dispatch:
+      - "mkdocs.yml"
+      - "README.md"
+      - "LICENSE"
 
 jobs:
   build:

.github/workflows/dev-docs.yml

@@ -0,0 +1,35 @@
+# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions
+name: Development Documentation
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push --update-aliases "${{ vars.NEXT_VERSION }}" dev

.github/workflows/docs.yml

@@ -1,20 +1,35 @@
-name: Build and Deploy Documentation
+# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions
+name: Documentation
 
 on:
   push:
-    tags:
-      - v**
-  workflow_dispatch:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+
+permissions:
+  contents: write
 
 jobs:
-  build:
-    name: Documentation
+  deploy:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4.1.7
-
-      - name: Deploy MkDocs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@1.26
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push --update-aliases "${{ vars.THIS_VERSION }}" latest

mkdocs.yml

@@ -33,6 +33,11 @@ theme:
         icon: material/brightness-4
         name: Switch to system preference
 
+extra:
+  version:
+    provider: mike
+    alias: true
+
 extra_css:
   - stylesheets/cp-button.css
   - stylesheets/fonts.css