Merge pull request #1728 from GhostWriters/deploy-adjustments

ci: 💚 use sparse checkout and cache properly

.github/workflows/deploy.yml

@@ -3,36 +3,65 @@ name: Build mkdocs and deploy to GitHub Pages
 on: [push, pull_request]
 
 jobs:
+
   build:
     name: Build docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
-      - uses: actions/setup-python@v5.0.0
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.1
+        with:
+          fetch-depth: 0
+          sparse-checkout: |
+            docs
+      - name: Setup python
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: 3.x
-      - uses: actions/cache@v4.0.0
+      - name: Get pip cache directory
+        id: pip-cache
+        run: |
+          echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+      - name: Cache dependencies
+        uses: actions/cache@v4.0.0
         with:
-          key: ${{ github.ref }}
-          path: .cache
-      - run: pip install -r docs/requirements.txt
-      - run: mkdocs build
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Build documentation
+        run: mkdocs build
 
   deploy:
     if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref)
     needs: build
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.1
         with:
-          fetch-depth: "0"
-      - uses: actions/setup-python@v5.0.0
+          fetch-depth: 0
+          sparse-checkout: |
+            docs
+      - name: Setup python
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: 3.x
-      - uses: actions/cache@v4.0.0
+      - name: Get pip cache directory
+        id: pip-cache
+        run: |
+          echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+      - name: Cache dependencies
+        uses: actions/cache@v4.0.0
         with:
-          key: ${{ github.ref }}
-          path: .cache
-      - run: pip install -r docs/requirements.txt
-      - run: mkdocs gh-deploy --force
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force