Automation Contracts¶
This page defines the stable promises around the Atlas development control plane, especially bijux-dev-atlas, suite execution, and governed report artifacts.
Contract Scope¶
flowchart LR
Automation[Automation contracts] --> Commands[Command families]
Automation --> Capabilities[Capability gating]
Automation --> Reports[Report schemas]
Automation --> Lanes[Suites and wrappers]
This contract-scope diagram shows the four parts of the control plane Atlas treats as stable enough to document for maintainers and automation consumers.
Main Promises¶
- repository automation remains discoverable through
bijux-dev-atlasand documented wrapper entrypoints - effectful commands fail closed when required capabilities are not explicitly allowed
- governed reports use versioned JSON schemas under
configs/schemas/contracts/reports/ - suite and check execution expose explicit selection inputs instead of hidden lane behavior
- structured consumers can rely on documented report fields more than terminal formatting
Report Schema Promise¶
For governed report families, the shared report contract includes:
report_idversioninputssummaryevidence
Report-specific fields may evolve, but breaking schema changes require a version bump and matching documentation, schema, and fixture updates.
That rule matters because reports are consumed by automation. Schema drift without versioning would turn review and CI behavior into guesswork.
Compatibility Rules¶
- additive fields should be safe for tolerant consumers
- breaking report changes require explicit schema-version change
- wrapper commands such as
make ci-prandmake docs-buildshould remain thin public entrypoints over the documented control-plane surface - lane selection must stay explicit enough that contributors can reproduce CI behavior locally
Non-Promise Areas¶
These details may change without becoming compatibility commitments:
- internal crate module names
- the exact number of runnables registered in a domain
- human-readable terminal phrasing that is not part of a documented report contract
- internal refactors that preserve command behavior, schema contracts, and documented wrappers
Related Pages¶
Purpose¶
This page defines the Atlas contract expectations for automation contracts. Use it when you need the explicit compatibility promise rather than a workflow narrative.
Stability¶
This page is part of the checked-in contract surface. Changes here should stay aligned with tests, generated artifacts, and release evidence.