IMPORTANT: Developer documentation for the current development branch. This content is unreleased, may change without notice, and must not be treated as Buildish release documentation.
Release model schema reference
This reference is generated from the Buildish Release Tooling Pydantic models and checked-in reference metadata. Do not edit it by hand; regenerate it with
make schemas.This reference describes the typed Buildish Release Tooling contracts that are checked into this repository. It covers supported external configuration and verification/report contracts, plus internal runtime contracts and internal unstable command action manifests.
How to read this reference
- file-contract pages identify stable checked-in file contracts where one exists
audiencedistinguishes supported external contracts from Buildish-owned internal contractsstabilitydistinguishes stable supported/internal contracts from intentionally unstable internal machine I/O- field names are shown in their wire-format aliases
- schema files link to the published JSON Schema contract for the matching root type
Reference pages
- File contract index — supported and internal file/root contract tables.
- Shared types reference — shared scalar aliases, literal sets, and enums.
- Release configuration and authored override types — Consumer-owned and component-owned authored configuration models, including
release-config.yamland local verify-rc override payloads. - Release manifests, inventories, and verification report types — Typed Buildish release manifests, emitted verification reports, inspection-bundle payloads, and related helper contracts.
- Internal unstable command action manifest types — Machine-readable command action manifests written for workflow coordination. These are Buildish-owned internal input/output contracts and are intentionally unstable.
- Harness configuration types — Committed and resolved release-harness configuration models.
- Harness scenario and runtime result types — Harness scenario inputs, mocked tool behavior contracts, and machine-readable run results.
- Harness shim builtin payload types — Small runtime payloads used by the harness shim to emulate GitHub and other tools.
Coverage notes
- generated schema files:
66 - command action manifests are documented here for maintenance and debugging, but they are intentionally unstable and not a supported external API.