ci: separate doc check into ci-docs.yml (read-only) and deploy into cd-docs.yml (push-only)

Author: vkarampudi

.github/workflows/cd-docs.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - 'master'
-  pull_request:
 
 permissions:
   contents: write
@@ -25,6 +24,7 @@ jobs:
           cache: 'pip'
           cache-dependency-path: |
             setup.py
+            requirements-docs.txt
 
       - name: Save time for cache for mkdocs
         run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
@@ -41,12 +41,7 @@ jobs:
         run: pip install -r requirements-docs.txt
 
       - name: Deploy to GitHub Pages
-        if: (github.event_name != 'pull_request')
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
           mkdocs gh-deploy --force
-
-      - name: Build docs to check for errors
-        run: mkdocs build
-        if: (github.event_name == 'pull_request')

.github/workflows/ci-docs.yml

@@ -0,0 +1,46 @@
+name: ci-docs
+
+on:
+  pull_request:
+    branches:
+      - 'master'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+          cache-dependency-path: |
+            setup.py
+            requirements-docs.txt
+
+      - name: Save time for cache for mkdocs
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - name: Caching
+        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Dependencies
+        run: pip install -r requirements-docs.txt
+
+      - name: Build docs to check for errors
+        run: mkdocs build