Keeps examples/integrations/* demos aligned to a single north-star so
drift doesn't pile up as the canonical demo evolves.
North-star (v1): langgraph-python — the richest demo (todos state, 5
tools, polished prompt, full frontend canvas). Every other integration demo
should track it.
Declared in manifest.json:
- verbatim files — copied byte-for-byte from north-star to each instance
(frontend components, hooks, lib, public assets, shared Docker files,
docker-compose.test.yml,entrypoint.sh,postcss.config.mjs, etc.) - package.json keys — tracked dependency versions and script names
(
@copilotkit/*,next,react, shared dev scripts). Per-instance overrides in manifest (packageJsonOverrides) win where the instance legitimately differs (e.g.dev:agentrunsnpm installin JS butuv syncin FastAPI). - canonical prompt —
_parity/canonical/PROMPT.md. Each agent inlines the prompt as a string literal in its source (matching the north-star'smain.pypattern). Verifier greps the canonical prompt's first non-blank line against instance agent source — drift = error. - agent surface — tool names + state keys expected to appear in each instance's agent source. Grep-level check — doesn't validate call-site correctness, that's the aimock fixture tests' job.
Per-instance allowedDivergence list in manifest.json:
agent/**— agents are written in different languages/runtimes (Python create_agent, TS StateGraph, Python StateGraph+FastAPI). Human-authored.src/app/api/copilotkit/**— north-star usesLangGraphAgent, Docker instances useHttpAgent. Different routes.Dockerfile,docker/Dockerfile.agent,serve.py,scripts/**— language-specific build/run tooling.
Anything outside both tracked and allowedDivergence is "no-op" — the
verifier neither checks nor touches it.
From the repo root:
# Sync a single instance to north-star (copies verbatim files, rewrites
# package.json keys, writes canonical prompt to agent/PROMPT.md)
pnpm parity:sync --target=langgraph-js
# Dry-run: show what would change without writing
pnpm parity:sync --target=langgraph-js --dry-run
# Sync every non-north-star instance
pnpm parity:sync --all
# Verify — exits non-zero on unexpected drift
pnpm parity:verify
pnpm parity:verify --target=langgraph-js
# CI invocation (same as verify, no color)
pnpm parity:checkpnpm parity:sync --all
pnpm parity:verify
# fix any agent-surface drift manually in the relevant agent/src/ files
git add . && git commit- Create the new demo under
examples/integrations/<name>/with a Next.js frontend at the root and anagent/dir. - Add an entry to
manifest.jsonunderinstances:"new-demo": { "role": "instance", "agent": { "language": "python", "runtime": "..." }, "allowedDivergence": ["agent/**", "src/app/api/copilotkit/**", "Dockerfile", "docker/Dockerfile.agent", "serve.py", "scripts/**"], "packageJsonOverrides": { "scripts.dev:agent": "..." } }
- Run
pnpm parity:sync --target=new-demo. - Hand-port the agent code (tools, state, prompt loading) — manifest
tracked.agentSurfacetells you what tool names and state keys are required. - Run
pnpm parity:verify --target=new-demountil green.
Edit manifest.json → tracked.agentSurface.toolNames / stateKeys.
The verifier will then flag every instance that hasn't caught up.
- Edit
_parity/canonical/PROMPT.md. - Update north-star's
agent/main.pyto use the new prompt string (north-star is where humans read; canonical file is what the verifier reads). - Port the new prompt into every instance's agent source (same manual-merge rules as any agent change).
pnpm parity:verify— verifier greps first line of canonical against each instance's agent source. Passes when all instances inline it.
.github/workflows/integrations_parity.yml runs pnpm parity:check on
every PR that touches examples/integrations/**. Failures link the
contributor back to this README.
- Declarative, not prescriptive. The manifest says what is tracked; the scripts just walk it. Adding a new tracked file = one line change, not a code change.
- Allowed-divergence is explicit, not implicit. Everything is either tracked, declared-divergent, or ignored — no silent "probably different" state.
- Agent surface is grep-level, on purpose. A real AST check would be
three times the code and still miss semantic drift. The existing aimock
fixture integration tests (under
fixtures/default.jsonper instance) are the real correctness check; this is the "did someone rip outmanage_todos" safety net. - North-star is read-only to the scripts.
sync.tsrefuses to write into the north-star directory even if asked. Verifier never touches anything.