Notebook build and deployment

Notebook build and deployment

Makefile targets

Script philosophy: Prefer shell scripts (scripts/​*.sh) with Unix tools (curl, jq, sed) for data fetching, and DuckDB SQL (via duckdb data.duckdb < query.sql) for data processing. Only use Python in unusual cases where shell scripts genuinely can't do the job.

Every notebook should define two data targets:

Simple notebook:

.PHONY: build preview etl data clean

build:
	yarn build

preview:
	yarn preview

etl: data

data:
	./​scripts/​fetch.sh
	duckdb data/​data.duckdb < scripts/​transform.sql

clean:
	rm -rf docs/​.observable/​dist data/​data.duckdb

Complex notebook (with heavy ETL uploaded to GitHub Releases):

.PHONY: build preview etl data clean

build:
	yarn build

preview:
	yarn preview

etl: data/​infrastructure.duckdb

data/​infrastructure.duckdb:
	./​scripts/​build_infra.sh

data:
	gh release download latest -p infrastructure.duckdb.gz -D data --clobber
	gunzip -f data/​infrastructure.duckdb.gz
	duckdb data/​data.duckdb < scripts/​export.sql

clean:
	rm -rf docs/​.observable/​dist data/​data.duckdb

Usage:

• make preview - local dev server with hot reload (http://localhost:3000)
• make build - compile to docs/​.observable/​dist/
• make etl - run expensive local computation (manual, infrequent)
• make data - lightweight data refresh (runs in GitHub Actions)
• make clean - remove build artifacts

Build process

Compiles docs/​index.html into standalone page:

1. Parse <notebook> element
2. Compile JS cells to modules
3. Bundle dependencies
4. Apply template.html
5. Output to docs/​.observable/​dist/

Important: SQL cells query at build time. Database needed for build, not deployment (results embedded in HTML).

GitHub Actions deployment

Each notebook repo has a minimal deploy.yml that calls a shared reusable workflow:

name: Deploy notebook

on:
  schedule:
    - cron: '0 6 1 * *'  # Monthly - adjust per repo
  workflow_dispatch:
  push:
    branches: [main]

jobs:
  deploy:
    uses: data-desk-eco/​.github/​.github/​workflows/​notebook-deploy.yml@main
    permissions:
      contents: write
      pages: write
      id-token: write
    secrets: inherit

The reusable workflow handles:

1. Checkout and setup (Node, Yarn, DuckDB)
2. Download shared template.html and .claude/ (includes skills and shared CLAUDE.md)
3. Run make data
4. Commit any changes
5. Run make build
6. Deploy to GitHub Pages

Pages setup: Settings → Pages → Source: GitHub Actions

Skip data step: For notebooks without a data target:

jobs:
  deploy:
    uses: data-desk-eco/​.github/​.github/​workflows/​notebook-deploy.yml@main
    with:
      skip_data: true
    # ...

Creating a new notebook

1. Use data-desk-eco.github.io as GitHub template
2. Enable Pages (Settings → Pages → Source: GitHub Actions)
3. Clone: git clone [url] && cd [repo] && yarn
4. Preview: make preview
5. Edit docs/​index.html
6. Push - deploys to https://research.datadesk.eco/[repo-name]/

Auto-updating files

These files download from the .github repo on each deploy:

• template.html - HTML wrapper
• .claude/ - Claude Code skills and shared instructions (.claude/​CLAUDE.md)

Don't edit these locally - changes will be overwritten.

Project-specific instructions: Create a root CLAUDE.md in your notebook repo for project-specific context. This file won't be overwritten and should be committed.