Quickstart: Release Prep

Run a go/no-go readiness check against your codebase — covering code quality, test coverage, security, and documentation — in a single call.

from release import ReleasePrepTeam

team = ReleasePrepTeam()
report = team.assess_readiness(".")
print(report.format_console_output())

Prerequisites

• Your project is cloned and dependencies are installed locally.
• The path you pass to assess_readiness contains the codebase you want to evaluate.

Steps

1. Create a ReleasePrepTeam.

Instantiate with default quality gates, or supply your own thresholds:

from release import ReleasePrepTeam

team = ReleasePrepTeam(quality_gates={"coverage": 0.80, "security": 0.90})

2. Run the readiness assessment.

Call assess_readiness with the path to your codebase. It coordinates CodeQualityAgent, TestCoverageAgent, DocumentationAgent, and SecurityAuditorAgent in parallel and returns a ReleaseReadinessReport:

report = team.assess_readiness(".")

3. Read the verdict.

print(report.format_console_output())
print("Approved:", report.approved)
print("Blockers:", report.blockers)

Expected output:

Release Readiness Report — 2026-06-02T10:56:02
==============================================
Approved: True
Confidence: high
Blockers: []
Warnings: ['CHANGELOG entry missing for patch bump']
Summary: All quality gates passed. Codebase is ready to ship.

If report.approved is True and report.blockers is empty, every critical QualityGate passed and your release is cleared to proceed. If report.approved is False, each entry in report.blockers describes a gate that failed — fix those before retrying.

4. Check costs (optional).

print("Total agent cost: $", team.get_total_cost())

Next: To integrate this check into a workflow pipeline, call ReleasePrepTeamWorkflow.execute(path=".") instead — it returns the same ReleaseReadinessReport and fits the CLI workflow registry.

Unresolved references

Auto-generated by attune-author fact-check. Review and either fix the source code, fix this doc, or add an override.