Integration Quick Start
Integrate Adapter Enforcement Into Tooling And CI
Use this flow at CI/CD time to connect Generation time checks to promotion gates so hosted tools remain enforceable even when they cannot hard-block in-product.
Canonical policy source: contracts/surfaces.web.contract.json
Quick Start
- Pick execution mode. Use workspace mode for local/CI promotion checks; use descriptor mode for hosted generator previews.
- Apply rollout parity rules. Descriptor color/icon parity is enforced only for surfaces listed in contracts/generation-descriptor-parity.json.
- Map verdict behavior in tool UX. Block publish on block, surface warnings on warn, allow pass.
- Review icon findings in workspace mode. When configured, `icon.source-disallowed` is surfaced here; warn policy stays non-blocking, strict policy blocks.
- Add CI fallback gate. Run workspace adapter check in CI and fail on exit code 30.
- Pin canonical contract path. Use contracts/surfaces.web.contract.json for canonical surfaces; use contracts/generated/reference-target-web.contract.json for reference-target demos.
- Store adapter findings with build artifacts. Use findings evidence for remediation and auditability.
CI / Local Integration Command
# Local/CI hard gate command
pnpm run adapter:validate-generation -- \
--tool codex \
--surface surfaces-web \
--mode workspace \
--workspace-root /Users/mike/SurfacesPlatform/surfaces-webapps \
--contract /Users/mike/SurfacesPlatform/surfaces-webapps/contracts/surfaces.web.contract.json
# Exit behavior:
# 0 => pass or warn
# 30 => block (fail CI)
# 10 => malformed request / missing contract
#
# Icon policy behavior in workspace mode:
# icon.source-disallowed + policy=warn => status=warn, exit 0
# icon.source-disallowed + policy=strict => status=block, exit 30
# CI validation findings are stored at artifacts/interfacectl-report.json
- workspace mode runs generation guard plus interfacectl validate.
- CI/CD workspace validation remains the authoritative promotion gate, even when descriptor parity is enabled.
- Descriptor mode parity is phased by surface; do not promote solely on descriptor-mode pass/warn.
- Hosted tools should call HTTP endpoint and still rely on CI hard gate for final promotion.
- In CI, inspect uploaded artifact artifacts/interfacectl-report.json for full findings.
Status Rules
pass No findings. Continue.
warn Warnings only. Continue with visibility.
block Strict/error finding present. Stop and fix.
Next Context
surfaces.dev quick start • integration