ci: migrate docs ci to zensical

Author: adinhodovic

.github/workflows/ci-cd.yml

@@ -12,6 +12,8 @@ on:  # yamllint disable-line rule:truthy
     types:
       - published
 
+permissions: read-all
+
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -71,16 +73,18 @@ jobs:
           enable-cache: true
 
       - name: Set up Python ${{ matrix.python-version }}
-        run: uv python install ${{ matrix.python-version }}
+        run: uv python install "$PY_VERSION"
+        env:
+          PY_VERSION: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: uv sync --all-extras
 
       - name: Test with tox
-        run: |
-          PY_VERSION=${{ matrix.python-version }} &&
-          uv run tox -e py${PY_VERSION//.}-${{ matrix.dj-version }}
+        run: uv run tox -e "py${PY_VERSION//.}-${DJ_VERSION}"
         env:
+          PY_VERSION: ${{ matrix.python-version }}
+          DJ_VERSION: ${{ matrix.dj-version }}
           REDIS_URL: redis://localhost:6379/0
 
       - name: Upload coverage to Codecov

.github/workflows/docs.yml

@@ -8,16 +8,15 @@ on:
     types:
       - published
 
-permissions:
-  contents: write
+permissions: read-all
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
@@ -30,21 +29,31 @@ jobs:
       - name: Install docs dependencies
         run: uv sync --extra docs
 
-      - name: Configure git
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-
-      - name: Fetch gh-pages branch
-        run: git fetch origin gh-pages --depth=1 || true
+      - name: Build docs
+        run: uv run zensical build
 
       - name: Deploy dev docs (on push to main)
         if: github.event_name == 'push'
-        run: uv run mike deploy --push dev
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          destination_dir: dev
+          keep_files: true
 
       - name: Deploy versioned docs (on release)
         if: github.event_name == 'release'
-        run: |
-          VERSION="${{ github.event.release.tag_name }}"
-          uv run mike deploy --push --update-aliases "$VERSION" latest
-          uv run mike set-default --push latest
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          destination_dir: ${{ github.event.release.tag_name }}
+          keep_files: true
+
+      - name: Update root (latest) on release
+        if: github.event_name == 'release'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          keep_files: true

.github/workflows/release-drafter.yml

@@ -6,26 +6,19 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - edited
   pull_request_target:
-    types: [opened, reopened, synchronize]
+    types: [opened, reopened, synchronize, edited]
 
-permissions:
-  contents: write  # for release-drafter/release-drafter to create a github release
-  pull-requests: write  # for release-drafter/release-drafter to add label to PR
+permissions: read-all
 
 jobs:
   update_pr_labels:
     name: Update PR Labels
-    if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target'
+    if: github.event_name == 'pull_request_target'
     runs-on: ubuntu-latest
+    permissions:
+      contents: read # for release-drafter to read config/repo metadata
+      pull-requests: write # for release-drafter to add labels to PR
     steps:
       - uses: release-drafter/release-drafter@v6
         with:
@@ -38,10 +31,21 @@ jobs:
     name: Update Release Draft
     if: github.event_name == 'push'
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # for release-drafter to create/update release draft
+    env:
+      PUBLISH_DRAFT: false
     steps:
+      - name: Check if a version is cut
+        if: "contains(github.event.head_commit.message, 'chore(prerelease): Cut Version')"
+        run: |
+          echo "PUBLISH_DRAFT=true" >> $GITHUB_ENV
+
+      # Drafts your next Release notes
       - uses: release-drafter/release-drafter@v6
         with:
           disable-autolabeler: true
           disable-releaser: false
+          publish: ${{ env.PUBLISH_DRAFT }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}