development · Command reference

`qzx prepareRelease`

What it does

Plans a release metadata update and can atomically update one manifest plus CHANGELOG.md; it never builds, commits, tags, or publishes

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.6a11. This page documents the 0.2.2.0.6a11 alpha development checkout.

Safety and effects

Can mutate state

Documented dry-run parameter

May invoke native programs

No documented network use

Outcome may depend on permissions

Preview is the default. Applying requires a fail-closed project backup, one unambiguous manifest, reviewed release notes when updating the changelog, and a clean Git worktree by default. It never runs tests, builds, commits, tags, publishes, or deploys.

Before mutation, QZX creates a recovery archive; --dangerously-bypass-approvals-and-sandbox/--yolo explicitly skips it.

This safety classification was reviewed by OpenAI Codex (authorized project audit) against implementation digest sha256:c58bca7394f654c198695cd00e4469fa7405f407649bb8da41758359bb3450e9 on 2026-07-30.

Exact syntax

qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
bump	str	No	"patch"	Version increment: patch, minor, or major
path	str	No	"."	Project directory to prepare
dry_run	bool	No	true	Preview the exact metadata changes without writing
new_version	str	No	Not declared	Explicit target version; recommended for pre-releases and projects that do not use three-part SemVer
release_notes	str	No	Not declared	Reviewed changelog text; required when applying with update_changelog=true
update_changelog	bool	No	true	Prepend a reviewed entry to CHANGELOG.md
require_clean_git	bool	No	true	Require the project to be a clean Git worktree before applying changes
manifest	str	No	Not declared	Explicit supported manifest path relative to the project when automatic detection would be ambiguous

Input examples

qzx prepareRelease

Preview the next patch version and all release-preparation preconditions

qzx prepareRelease --new-version 2.0.0rc1 --release-notes "Release candidate with reviewed fixes" --dry-run false

Back up a clean project, then atomically prepare an explicit Python pre-release without committing or tagging

For the complete structured payload, add --json: qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx prepareRelease --json

{
    "success": true,
    "message": "Plans a release metadata update and can atomically update one manifest plus CHANGELOG.md; it never builds, commits, tags, or publishes. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "prepareRelease",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "changes_applied": true,
    "dry_run": true,
    "plan": "Example value",
    "status": "ok"
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "changes_applied": {
            "type": "boolean"
        },
        "dry_run": {
            "type": "boolean"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "plan": [],
        "status": {
            "type": "string"
        }
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires a controlled privileged environment.

Evidence and provenance

Implementation: src/qzx/commands/development/prepare_release.py
Tests: tests/test_development_commands/test_prepare_release.py
Documentation channel: Development documentation 0.2.2.0.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Availability: 0.2.2.0.6a11 or earlier

Keep exploring

These commands also belong to the development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands