Skip to content

DISTRIBUTION.md

Latest commit

 

History

History
46 lines (29 loc) · 1.99 KB

DISTRIBUTION.md

File metadata and controls

46 lines (29 loc) · 1.99 KB
Raw

Schema Distribution

Released CAS schemas are distributed from:

https://coding-autopilot-system.github.io/cas-contracts/

Schema $id values use the reserved canonical namespace https://schemas.coding-autopilot.dev/. Until DNS is configured for that domain, consumers must resolve schemas from the live GitHub Pages distribution URL.

URL Contract

Use a stable major/minor URL when a consumer should automatically receive compatible patch releases:

https://coding-autopilot-system.github.io/cas-contracts/v0.1/prompt-envelope.schema.json

Use an immutable release URL when builds or evidence must remain reproducible:

https://coding-autopilot-system.github.io/cas-contracts/releases/v0.1.0/prompt-envelope.schema.json

Discovery and integrity metadata are available from:

  • /index.json: available releases and the current release for each major/minor line.
  • /v0.1/manifest.json: schemas and SHA-256 digests for the current compatible release.
  • /releases/v0.1.0/manifest.json: schemas and SHA-256 digests for one immutable release.

Local Build

npm run build:registry -- --version 0.1.0
npm run validate:registry -- --registry registry

The command writes registry/, validates the version, preserves relative schema references, and produces deterministic manifests.

Publication

Pushing a semantic version tag such as v0.1.1 runs .github/workflows/publish-registry.yml. The workflow rebuilds every tagged release, preserves immutable release paths, advances stable major/minor paths, validates the repository, and deploys the result to GitHub Pages.

Repository administrators must configure GitHub Pages to use GitHub Actions as its source. Publication uses GitHub's OIDC token and does not require stored deployment credentials.

To activate a verified custom domain, configure its DNS records and set the repository Actions variable SCHEMA_DOMAIN. The publication workflow emits CNAME only when that variable is explicitly configured.