OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

CI gating with deterministic diffs

Add ContractSpec CI checks that validate specs, detect drift, and gate breaking changes before merge.

What you'll build

CI workflow running ContractSpec validation and drift checks.
Machine-readable output for PR annotations.
Deterministic contract diffs in review.

1) Add the CI workflow

Copy the template from the CLI package.

1cp node_modules/@lssm-tech/app.cli-contractspec/templates/github-action.yml .github/workflows/contractspec.yml

Expected output: new workflow file in .github/workflows.

2) Run CI locally

1contractspec ci --format json --check-drift

Expected output: JSON summary including pass/fail counts and drift status (if configured).

3) Add a diff check

Use the diff command to inspect breaking changes in PRs.

1contractspec diff src/contracts/spec-v1.ts src/contracts/spec-v2.ts --breaking

Expected output: deterministic diff with breaking change hints.

Example package

The CRM pipeline example is already wired in the quickstart smoke test. Use it as a CI-ready template.

1cd packages/examples/crm-pipeline
2bun run build
3bun run validate

Need continuous checks tied to outcomes?

Studio closes the loop with post-change verification and learning dividends that improve future decisions.

See what Studio adds

Back to guides Docs home

OSS docsoperateStart with OSS. Adopt Studio when you want the operating layer.

Author release capsules

Pair changesets with structured release capsules, generate release artifacts, and keep changelog plus docs surfaces aligned.

Why ContractSpec

Keep educational and comparison content reachable without letting it define the primary OSS learning path.

Manifesto Contract-first API Spec-driven development

Open system docs