Public Release Use Cases¶
Status: active Last updated: 2026-05-28
This document defines the minimum use cases that must be clearly understood, validated, and evidenced before a public release.
1. Purpose¶
Use this catalog to answer one question: "Are we truly ready to expose this publicly without ambiguity?"
Why this catalog is useful now:
- It turns readiness into evidence, so the team can prove progress instead of debating it.
- It keeps the release bar explicit, which reduces last-minute guesswork.
- It separates durable repo-backed proof from manual operational checks, which makes the process honest and auditable.
- It gives reviewers a single narrative for why the current system is safer and more repeatable than an ad hoc release process.
A release candidate is considered clear and publishable only when each required use case below has:
- A concrete execution path
- A measurable acceptance criterion
- Attached evidence (artifact/report/log)
2. Required Use Cases Before Public Launch¶
UC-01: Basic capability execution path¶
Goal:
- A representative skill executes end-to-end with expected output mapping.
How to validate:
- Run smoke and capability contract checks.
- Run at least one real skill execution with trace correlation.
Acceptance criteria:
- Smoke verification passes.
- Contract validation passes.
- Skill returns expected required outputs with no mapping errors.
Evidence:
artifacts/smoke_report.json- Contract test output from
tooling/test_capability_contracts.py - Execution trace/log with trace id
UC-02: Registry-governed consistency and freshness¶
Goal:
- Registry is valid and catalog artifacts are fresh (no drift).
How to validate:
- Run the full registry CI-equivalent sequence.
Acceptance criteria:
- All registry governance scripts pass.
- No catalog freshness drift remains after generation.
Evidence:
- Outputs from:
tools/validate_registry.pytools/governance_guardrails.pytools/capability_governance_guardrails.pytools/enforce_capability_sunset.pytools/generate_catalog.pytools/registry_stats.py
UC-03: Policy bundle lifecycle governance¶
Goal:
- OPA bundle manifest and rego contract remain valid and promotion-safe.
How to validate:
- Run lifecycle verifier and schema checks through CI governance gate.
Acceptance criteria:
- Lifecycle report status is
passed. - No manifest schema conformance failures.
- Tenant scope and promotion policy checks pass.
Evidence:
artifacts/policy_bundle_lifecycle_report.jsonartifacts/policy_gate_freshness_report.json
UC-04: Runtime canary safety controls¶
Goal:
- Runtime safety remains intact under canary checks.
How to validate:
- Run runtime canary suite including durability, policy shadow, and tenant matrix.
Acceptance criteria:
- Runtime canary job passes.
- Durability, shadow parity, and tenant isolation reports pass.
- Replay determinism report passes with complete repeated execution set.
- Workflow version compatibility report passes with full execution set and no failed tests.
- Checkpoint schema/provenance report passes with full execution set and no failed tests.
- Provenance coverage report passes with full execution set and no failed tests.
Evidence:
artifacts/durability_contract_report.jsonartifacts/policy_shadow_report.jsonartifacts/tenant_isolation_matrix_report.jsonartifacts/durability_advanced_report.jsonartifacts/replay_determinism_report.jsonartifacts/workflow_version_compatibility_report.jsonartifacts/checkpoint_schema_provenance_report.jsonartifacts/provenance_coverage_report.json
UC-05: Promotion-readiness decision path¶
Goal:
- Promotion decisions are explicit and evidence-based for
dev -> staging -> prod.
How to validate:
- Generate and verify policy promotion readiness reports.
Acceptance criteria:
- Promotion readiness report status is
passed. - Verification report status is
passed. dev_to_staging.readyandstaging_to_prod.automated_readyare true.
Evidence:
artifacts/policy_promotion_readiness_report.jsonartifacts/policy_promotion_readiness_verify_report.json
UC-06: Branch protection operational closure¶
Goal:
- The repository's public release branch is effectively protected in GitHub.
Why this matters:
- Governance closes the gap between code state and release authority.
- Required checks and review rules protect the release path from accidental bypass.
- The manual UI proof path acknowledges that some controls live outside the repo while still keeping the evidence package complete.
How to validate:
- Apply/verify ruleset using GitHub UI runbook.
- Run branch protection verifiers.
Acceptance criteria:
- Required checks match canonical file.
- PR review and conversation safeguards are active.
- Bypass scope is minimal and reviewed.
Evidence:
artifacts/branch_protection_policy_report.jsonartifacts/required_status_checks_consistency_report.jsonartifacts/github_branch_protection_report.jsonor manual UI proof whenunverified
4. Why This Release Model Is Stronger¶
The current model is intentionally stricter than a typical "works on my machine" or "push and hope" release process. It is stronger because:
- Every release claim is backed by concrete artifacts, not just tribal knowledge.
- Runtime safety, governance, and promotion readiness are checked independently.
- Evidence is reusable across release decisions, so the same work supports multiple gates.
- Operators can understand the release state quickly from the reports without reverse engineering the system.
UC-07: Workflow integrity against regressions¶
Goal:
- CI workflow embedded Python snippets are syntactically safe.
How to validate:
- Run embedded-workflow Python verifier.
Acceptance criteria:
- Embedded Python report status is
passed.
Evidence:
artifacts/workflow_embedded_python_report.json
UC-08: Stability trend for critical jobs¶
Goal:
- Critical CI jobs show acceptable pass-rate trend before public exposure.
How to validate:
- Generate trend report and evaluate trend SLO report.
Acceptance criteria:
- Trend report is generated.
- SLO evaluation has no blocking breaches for configured policy.
Evidence:
artifacts/critical_ci_trend_report.jsonartifacts/critical_ci_trend_slo_report.json
UC-09: Consolidated governance readability¶
Goal:
- Release decision can be made from executive summaries without digging into all raw files.
How to validate:
- Generate executive summary artifacts in CI governance and runtime canary jobs.
Acceptance criteria:
- Executive summary artifacts exist and are readable.
- Status is not
failed.
Evidence:
artifacts/governance_executive_summary.jsonartifacts/runtime_governance_executive_summary.jsonartifacts/release_readiness_gate_report.jsonartifacts/release_lineage.json
UC-10: Operator readiness for incidents¶
Goal:
- Team can react quickly to regression after release.
How to validate:
- Verify incident triggers and first-response steps are documented.
Acceptance criteria:
- Incident triggers and immediate actions are clear and linked.
Evidence:
docs/PRODUCTION_READINESS.mdincident sectiondocs/TROUBLESHOOTING.mdand related runbooks
UC-11: Cognitive quality threshold compliance¶
Goal:
- Pure cognitive capability quality remains above release threshold.
How to validate:
- Run cognitive gate bundle.
- Generate quality scorecard with threshold enforcement.
Acceptance criteria:
- Cognitive gates report status is
passed. - Scorecard threshold failures count is
0. - Average axis and overall scores are greater than or equal to configured threshold.
Evidence:
artifacts/cognitive_quality_gates_local_report.jsonartifacts/cognitive_quality_scorecard.jsonartifacts/cognitive_e2e_contract_report.jsonartifacts/cognitive_semantic_all_report.json
3. Public Launch Decision Matrix¶
Release decision:
- Go:
- All required use cases accepted.
- No
failedgovernance summaries. - Any
unverifiedis only the allowed branch-protection visibility case with manual evidence. - No-Go:
- Any required use case missing evidence.
- Any policy/runtime governance control failed.
- Any unverified outside the allowed exception rule.
4. Suggested Release Evidence Package¶
Attach this package to release notes/PR:
- CI run URL(s) for
policy-bundle-governance,runtime_canary,ci_stability_trend, anddx_metrics - Governance executive summary artifacts
- Runtime governance executive summary artifacts
- Release readiness gate artifact
- Release lineage artifact
- Registry validation sequence output
- Branch protection verification evidence (API report or UI proof)
5. Cross References¶
docs/PRODUCTION_READINESS.mddocs/CI_AND_TESTING.mddocs/GITHUB_RULESET_RUNBOOK.mddocs/OPA_POLICY_BUNDLE_LIFECYCLE.mddocs/PRODUCT_100_EXECUTION_PLAN.mddocs/RELEASE_LINEAGE_MODEL.md