test

.github/workflows/ci-docs.yml

@@ -1,25 +1,26 @@
 name: CI - Docs build check
 
 on:
-  pull_request:
-    branches-ignore:
-      - gh-pages
-  push:
+  push: 
+    branches:
+      - main
+      - develop
+      - release-candidate
   workflow_dispatch:
 
 permissions:
   contents: read
 
 env:
-  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT:-true }}
+  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
   MKDOCS_CONFIG: mkdocs/mkdocs.yml 
+  MKDOCS_OFFLINE: false
   CSPELL_CONFIG: tools/spellcheck/cspell.yml
-  CSPELL_TARGETS: "docs/**/*.md" README.md
+  CSPELL_TARGETS: docs/**/*.md README.md
 
 jobs:
   build-check:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -33,7 +34,7 @@ jobs:
         run: |
           set -euo pipefail
           npx --yes cspell \
-            --config ${CSPELL_CONFIG \
+            --config ${CSPELL_CONFIG} \
             ${CSPELL_TARGETS}
 
       - name: Install build dependencies

.github/workflows/release.yml

@@ -0,0 +1,97 @@
+name: Build & publish docs (rc + release)
+
+on:
+  push:
+    tags:
+      - "rc*"
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  MKDOCS_CONFIG: mkdocs/mkdocs.yml
+  MKDOCS_OUTPUT_DIR: ${{ runner.temp }}/dist
+  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install deps
+        run: |
+          set -euo pipefail
+          pip install -r mkdocs/requirements.txt
+
+      - name: Build docs (strict gate)
+        run: |
+          set -euo pipefail
+
+          FLAGS=()
+          if [ "${MKDOCS_STRICT}" = "true" ]; then
+            FLAGS+=(--strict)
+          fi
+
+          mkdir -p "${MKDOCS_OUTPUT_DIR}"
+
+          OFFLINE="${OFFLINE:-true}" mkdocs build \
+            "${FLAGS[@]}" \
+            -f "${MKDOCS_CONFIG}" \
+            -d "${MKDOCS_OUTPUT_DIR}/offline"
+            mkdocs build \
+            "${FLAGS[@]}" \
+            -f "${MKDOCS_CONFIG}" \
+            -d "${MKDOCS_OUTPUT_DIR}/dist"
+
+      - name: Zip site
+        run: |
+          set -euo pipefail
+          cd "${MKDOCS_OUTPUT_DIR}"
+          zip -r "${GITHUB_REF_NAME}.zip" "./offline"
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      # -------------------------
+      # RC-only step
+      # -------------------------
+      - name: Publish prerelease 
+        if: startsWith(github.ref_name, 'rc-')
+        uses: softprops/action-gh-release@v2
+        with:
+          prerelease: true
+          name: ${{ github.ref_name }}
+          tag_name: ${{ github.ref_name }}
+          body: |
+            Release candidate preview (if deployed): /rc/
+          files: |
+            ${{ runner.temp }}/${{ github.ref_name }}.zip
+
+      # -------------------------
+      # Final release-only step
+      # -------------------------
+      - name: Publish release
+        if: startsWith(github.ref_name, 'v')
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ github.ref_name }}
+          tag_name: ${{ github.ref_name }}
+          files: |
+            ${{ runner.temp }}/${{ github.ref_name }}.zip
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy
+        run: |
+          echo "TBD :)"
+