Refactor GitHub Actions workflow for Jupyter Book deployment: update branch names, streamline steps, and enhance Python setup.

Author: aaronjnewman

.github/workflows/deploy.yml

@@ -1,16 +1,21 @@
 # This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
 # Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
 
-name: Jupyter Book (via myst) GitHub Pages Deploy
+name: Jupyter Book HTML Deploy
 on:
   push:
-    # Runs on pushes targeting the default branch
-    branches: [main]
+    # Trigger on pushes to the actual default branch (master in this repo)
+    branches: [ master ]
+  workflow_dispatch:
+    inputs:
+      clean:
+        description: "Clean _build before building"
+        required: false
+        type: boolean
+        default: false
 env:
-  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
-  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
-  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
-  BASE_URL: /${{ github.event.repository.name }}
+  # Custom domain already configured (neuraldatascience.io), serve from root
+  BASE_URL: ''
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
@@ -23,26 +28,45 @@ concurrency:
   group: 'pages'
   cancel-in-progress: false
 jobs:
-  deploy:
+  build-deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-      - uses: actions/setup-node@v4
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          node-version: 18.x
-      - name: Install Jupyter Book (via myst)
-        run: npm install -g jupyter-book
-      - name: Build HTML Assets
-        run: jupyter-book build --html
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          # Install jupyter-book (latest 2.x) explicitly; pin if stability needed
+          pip install jupyter-book
+      - name: (Optional) Clean previous builds
+        if: inputs.clean == 'true'
+        run: jupyter-book clean .
+      - name: Build book (HTML)
+        run: jupyter-book build .
+      - name: List build output (debug)
+        run: |
+          ls -R _build/html | head -50 || echo "No html output found"
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: './_build/html'
+          path: _build/html
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4