Set up uv for dependency management and add PR preview workflow

Author: ianhi

.github/workflows/gh-pages.yml

@@ -23,15 +23,19 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    # Install dependencies
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v5
+    # Install uv for faster dependency management
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
       with:
-        python-version: '3.11'
-        cache: pip # Implicitly uses requirements.txt for cache key
+        enable-cache: true
 
+    # Set up Python using uv
+    - name: Set up Python
+      run: uv python install 3.11
+
+    # Install dependencies using uv
     - name: Install dependencies
-      run: pip install -r requirements.txt
+      run: uv sync
 
     # (optional) Cache your executed notebooks between runs
     # if you have config:
@@ -41,12 +45,12 @@ jobs:
       uses: actions/cache@v4
       with:
         path: _build/.jupyter_cache
-        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+        key: jupyter-book-cache-${{ hashFiles('uv.lock') }}
 
     # Build the book
     - name: Build the book
       run: |
-        jupyter-book build .
+        uv run jupyter-book build .
 
     # Upload the book's HTML as an artifact
     - name: Upload artifact

.github/workflows/pr-preview.yml

@@ -0,0 +1,62 @@
+name: PR Preview
+
+# Build the book on pull requests for preview
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  build-preview:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    # Install uv for faster dependency management
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    # Set up Python using uv
+    - name: Set up Python
+      run: uv python install 3.11
+
+    # Install dependencies using uv
+    - name: Install dependencies
+      run: uv sync
+
+    # Cache executed notebooks between runs
+    - name: Cache executed notebooks
+      uses: actions/cache@v4
+      with:
+        path: _build/.jupyter_cache
+        key: jupyter-book-cache-${{ hashFiles('uv.lock') }}
+
+    # Build the book
+    - name: Build the book
+      run: |
+        uv run jupyter-book build .
+
+    # Upload the book's HTML as an artifact
+    - name: Upload book artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: book-html-${{ github.event.pull_request.number }}
+        path: "_build/html"
+        retention-days: 7
+
+    # Post comment with artifact link
+    - name: Comment PR
+      uses: actions/github-script@v7
+      if: github.event_name == 'pull_request'
+      with:
+        script: |
+          const artifactUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: `📚 Book preview build completed! [Download the artifact](${artifactUrl}) to view the HTML locally.`
+          })

pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "xarray-for-biology"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "flox>=0.10.6",
+    "jupyter-book>=1.0.4.post1",
+    "jupyterlab>=4.4.7",
+    "matplotlib>=3.10.6",
+    "numpy>=2.3.2",
+    "xarray>=2025.8.0",
+]