docs: Deploy docs only on docs changes or manual trigger - #422

.github/workflows/deploy-docs.yml (1)

7-9: ⚠️ Potential issue | 🟠 Major

Keep TypeDoc inputs in the deploy trigger.

This workflow still regenerates docs/api/** from package sources (pnpm run docs:build:typedoc), so dropping non-docs/** inputs here means API docs stop updating when packages or docs-build config change.

Suggested trigger adjustment

   push:
     branches:
       - main
     paths:
       - 'docs/**'
+      - 'packages/**'
+      - 'package.json'
+      - 'pnpm-lock.yaml'
+      - 'turbo.json'
       - '.github/workflows/deploy-docs.yml'

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/deploy-docs.yml around lines 7 - 9, The deploy-docs
workflow removed inputs that trigger TypeDoc rebuilds; update the paths array in
the deploy-docs workflow to include package source and docs-build config changes
so pnpm run docs:build:typedoc still runs when relevant code/config changes —
e.g., re-add patterns for package sources (packages/** or your monorepo package
folders), root manifest/lock files (package.json, pnpm-lock.yaml) and any
TypeScript/TypeDoc config files used by the build (tsconfig*.json,
typedoc.json), ensuring the existing docs/** and the workflow file remain listed
so API docs regenerate correctly when package or config changes occur.

.github/workflows/sync-examples.yml (1)

84-98: ⚠️ Potential issue | 🟠 Major

Update all @sqlrooms/* dependency sections, not just dependencies.

The jq filter on lines 90–97 only updates .dependencies. References in devDependencies, peerDependencies, or optionalDependencies remain as workspace:* and will fail to resolve when line 108 runs npm install --package-lock-only outside the monorepo.

Five manifests currently have @sqlrooms/* entries in non-dependencies sections:

• Root package.json also lacks a .dependencies section entirely (only devDependencies)
• packages/ai-core/package.json, packages/room-store/package.json: @sqlrooms/* in devDependencies
• packages/duckdb/package.json: @sqlrooms/* in devDependencies
• packages/duckdb-node/package.json: @sqlrooms/* in peerDependencies

The fix should iterate all four sections (dependencies, devDependencies, peerDependencies, optionalDependencies) and handle manifests that lack a .dependencies section:

Suggested fix

-            jq --arg version "$VERSION" \
-              '(.dependencies | with_entries(
-                if .key | startswith("@sqlrooms/")
-                then .value = $version
-                else .
-                end
-              )) as $deps
-              | .dependencies = $deps' "$file" > temp.json
+            jq --arg version "$VERSION" '
+              reduce ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"][] as $section
+                (.;
+                  if .[$section] == null then .
+                  else .[$section] |= with_entries(
+                    if .key | startswith("@sqlrooms/")
+                    then .value = $version
+                    else .
+                    end
+                  )
+                  end
+                )
+            ' "$file" > temp.json

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/sync-examples.yml around lines 84 - 98, The current jq
invocation in the find loop only updates .dependencies and leaves workspace:*
entries in devDependencies, peerDependencies, and optionalDependencies; update
the jq filter used in the loop (the command that builds temp.json for each
"$file") to process all four sections by mapping over [.dependencies,
.devDependencies, .peerDependencies, .optionalDependencies] (creating missing
objects if they don’t exist) and replace any keys starting with "@sqlrooms/"
with $version in each section; keep the surrounding shell logic (VERSION=$(jq -r
'.version' source/lerna.json), the find ... | while read -r file; do loop,
temp.json mv "$file") but change only the jq expression so it updates or creates
those sections for the given file variable.