From 83f5f75046695cadb23989494a01d90e64eb19e4 Mon Sep 17 00:00:00 2001
From: Eric Nemchik <eric@nemchik.com>
Date: Sat, 17 Feb 2024 19:19:06 -0600
Subject: [PATCH] ci: :green_heart: use sparse checkout and cache properly
 (#1803)

Signed-off-by: Eric Nemchik <eric@nemchik.com>
---
 .github/workflows/deploy.yml | 40 +++++++++++++++++++++++++++++-------
 1 file changed, 33 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 31019a057..26494ed0d 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -3,25 +3,40 @@ name: Build and Deploy Docs
 on: [push, pull_request]
 
 jobs:
+
   build:
     name: Build docs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4.1.1
-      - name: Set up Python
+        with:
+          fetch-depth: 0
+          sparse-checkout: |
+            docs
+            images
+            includes
+            overrides
+      - name: Setup python
         uses: actions/setup-python@v5.0.0
         with:
           python-version: 3.x
+      - 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:
-          path: .cache
-          key: ${{ runner.os }}-build-${{ hashFiles('docs/requirements.txt') }}
+          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
@@ -33,16 +48,27 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4.1.1
         with:
-          fetch-depth: '0'
-      - name: Set up Python
+          fetch-depth: 0
+          sparse-checkout: |
+            docs
+            images
+            includes
+            overrides
+      - name: Setup python
         uses: actions/setup-python@v5.0.0
         with:
           python-version: 3.x
+      - 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:
-          path: .cache
-          key: ${{ runner.os }}-build-${{ hashFiles('docs/requirements.txt') }}
+          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