ci: use jupyter cache in docs ci builds to speed up docs builds

ibis-project · Sep 14, 2024 · f708610 · f708610
1 parent ff3550c
commit f708610
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/.github/workflows/docs-preview.yml b/.github/workflows/docs-preview.yml
@@ -70,6 +70,12 @@ jobs:
             done
           } | tee /tmp/comment
 
+      - name: restore cache of the previously rendered notebooks
+        uses: actions/cache/restore@v4
+        with:
+          key: docs-${{ github.base_ref }}
+          path: docs/**/.jupyter_cache
+
       - name: build docs
         run: nix develop --ignore-environment --keep HOME -c just docs-build-all
 

diff --git a/.github/workflows/ibis-docs-main.yml b/.github/workflows/ibis-docs-main.yml
@@ -34,6 +34,20 @@ jobs:
       - name: checkout
         uses: actions/checkout@v4
 
+      - name: get upstream commit
+        id: get-upstream-commit
+        run: |
+          set -euo pipefail
+
+          sha="$(git rev-parse HEAD~)"
+          echo "sha=${sha}" >> "$GITHUB_OUTPUT"
+
+      - name: restore cache of the previously rendered notebooks
+        uses: actions/cache/restore@v4
+        with:
+          key: docs-${{ steps.get-upstream-commit.outputs.sha }}
+          path: docs/**/.jupyter_cache
+
       - name: run doctests
         # keep HOME because duckdb (which we use for doctests) wants to use
         # that for extensions
@@ -45,6 +59,12 @@ jobs:
       - name: build docs
         run: nix develop --ignore-environment --keep HOME -c just docs-render
 
+      - name: cache rendered notebooks
+        uses: actions/cache/save@v4
+        with:
+          key: docs-${{ github.sha }}
+          path: docs/**/.jupyter_cache
+
       - name: build jupyterlite
         run: nix develop --ignore-environment --keep HOME -c just build-jupyterlite
 

diff --git a/.github/workflows/ibis-docs-pr.yml b/.github/workflows/ibis-docs-pr.yml
@@ -36,6 +36,12 @@ jobs:
       - name: checkout
         uses: actions/checkout@v4
 
+      - name: restore cache of the previously rendered notebooks
+        uses: actions/cache/restore@v4
+        with:
+          key: docs-${{ github.base_ref }}
+          path: docs/**/.jupyter_cache
+
       - name: run doctest
         # keep HOME because duckdb (which we use for doctests) wants to use
         # that for extensions