[ AxiomCore · Documentation ]
Production readiness
Check contract provenance, consumers, security, data, operations and rollback before you promote a release, and review Security Mode changes.
Use this checklist before you promote a backend, contract or consumer to
production. Passing axiom build is necessary but not sufficient. Work through
the list for the exact backend, consumer, target and environment you are
promoting.
Contract and provenance
- The authoritative input (Acore source or extracted backend) is identified and reviewable.
- CLI, extractor and package versions are pinned for the release job.
- Contract and package locks are committed and verified.
- The candidate artifact digest matches the artifact your consumers tested.
- The semantic diff from the accepted version has an explicit owner.
- Production policy requires the intended signature and proof boundary.
Behavior and consumers
- Contract tests cover representative success, validation, authentication and error paths.
- At least one test reaches the real backend through
axiom serveor the adapted application, including its real providers. Contract mock tests alone are not enough. - Every generated client is rebuilt from the candidate artifact.
- Web CORS, CSP and browser support are verified.
- Flutter or native consumers are tested in their release configuration.
- Someone owns loading, empty, retry, cancellation, cache and reconnect behavior.
Security and data
- The
axiom security checkresult matches the intended enforcement mode. - Public routes are explicit, and protected routes have the expected guard.
- Secrets come from the deployment environment. They do not appear in source, locks, artifacts, examples, logs or CI evidence.
- Sandbox and test data are synthetic and isolated from production.
- Sensitive fields and telemetry attributes are redacted or excluded.
Operations
- Environment endpoints, timeouts, retry policy and credential transport are reviewed.
- Logs, traces, traffic metrics, alert ownership and retention are configured for the deployed path.
- A release health signal is defined before promotion.
- The previous immutable artifact and dependency lock remain available.
- Rollback has been rehearsed without resolving new dependencies.
- Ownership of the backend, contract, frontend and Cloud project is recorded.
Review security changes
Security Mode is an opt-in contract setting. With it enabled, the compiler records AXSEC findings, endpoint coverage, the policy graph and source evidence in the artifact. A contract pull request then compares the signed security manifests of two releases, not a scan run in the browser.
| Mode | Build and release behavior |
|---|---|
audit | Findings are warnings. The build and release continue. |
strict | A finding with error severity rejects the build. Cloud release processing also rejects the release. |
Check locally before you build:
axiom security check axiom.acoreSecurity Mode strict · 1 error(s), 0 warning(s) · 0 of 1 endpoints covered (0 direct, 0 default-policy)
AXSEC-001 ERROR [list] `list` is externally reachable but has no explicit public declaration or authorization policy.
→ Declare `security.endpoints[endpoint]` as public or bind it to a user-defined policy.
Error: security check found 1 error(s) and 0 warning(s)Review flow:
- Build and release a candidate contract with Security Mode enabled.
- Open a contract pull request between the accepted release and the candidate.
- Select the Security view. Each change is labeled as a policy change or a finding change. Removing a policy is breaking; other policy and finding changes are risky.
- Record reviewer comments in the pull request.
- Promote the reviewed release.
In the dashboard, the contract page shows the Security Mode, the manifest hash, counts of protected and uncovered routes, and each finding with a suggested next step. Security Audit shows the current contract posture. Client runtime traces record the signed security hash, mode and declared policy, authentication and permission context. Trace detail shows this as Security decision context: declared policy bindings and AXSEC posture, not a reconstructed server-side authorization decision.
Questions to answer in review:
- Is every reachable endpoint explicitly public or protected?
- Which relation proves that a requester may access a resource addressed by ID?
- Does a changed projection expose classified data to a new audience?
- Are egress, uploads, paths, processes, CORS, cache and logs constrained?
- Is each
declared_unprovenfinding backed by real trusted middleware or an adapter?
This review gives governance and reproducibility. It does not replace threat modeling, code review, penetration testing, dependency scanning or trusted runtime enforcement. See Security rules for every AXSEC rule.
Platform boundary
Do not make a Coming soon product a release dependency. Axiom Studio, Acode and Axiom Marketplace are product direction, not supported production workflows. Acore UI hosts are Alpha development paths, and physical-device certification and app-store publishing are not claimed. Check the support matrix again whenever the CLI or runtime version changes.
Next steps
Releases and upgrades
Release an immutable contract version, upgrade its consumers, release application artifacts and roll back without rewriting history.
Axiom Cloud
What the Axiom Cloud dashboard and API do today, what is Coming soon, and how workspaces, projects, releases, environments, secrets and resources fit together.