development · Command reference
qzx releaseProject
What it does
Handles release workflow: bumps versions in manifests, generates CHANGELOG.md, builds, hashes assets, commits, and tags (supports dry-run)
Canonical command: releaseProject
Accepted aliases: None
Case-sensitive: no
Included in the published package
Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 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
Before mutation, QZX creates a recovery archive; --dangerously-bypass-approvals-and-sandbox/--yolo explicitly skips it.
This safety classification was reviewed against implementation digest sha256:8de305c7a4a9ea2046996fb90b4870effecffd9620643b5f871e5b3064a298a2 on 2026-07-24.
Exact syntax
qzx releaseProject [bump] [path] [dry_run] --jsonParameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| bump | str | No | "patch" | Semantic version bump type: patch, minor, major (default: 'patch') |
| path | str | No | "." | Path to project directory (default: '.') |
| dry_run | bool | No | true | If True, simulate release without mutating files or running git commits (default: True) |
Input examples
qzx releaseProjectPreview a patch release
qzx releaseProject --bump minor --dry_run falseBack up and run a minor release
For the complete structured payload, add --json: qzx releaseProject [bump] [path] [dry_run] --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 releaseProject --json
{
"success": true,
"message": "Handles release workflow: bumps versions in manifests, generates CHANGELOG.md, builds, hashes assets, commits, and tags (supports dry-run). In this illustrative example, the command completed successfully.",
"details": {
"old_version": "Example value",
"new_version": "Example value",
"preflight": "Example value",
"changelog_updated": "Example value",
"build_result": "Example value",
"artifacts": [
{
"name": "example",
"status": "ok"
}
],
"package_created": "Example value",
"git_commit": "Example value",
"git_tag": "Example value",
"dry_run_mode": true
}
}View the JSON result contract
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"success",
"message"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"details": {
"oneOf": [
{
"type": "object",
"properties": {
"old_version": [],
"new_version": [],
"preflight": [],
"changelog_updated": [],
"build_result": [],
"artifacts": [],
"package_created": [],
"git_commit": [],
"git_tag": [],
"dry_run_mode": []
},
"additionalProperties": true
},
{
"type": "object",
"properties": {
"old_version": [],
"new_version": [],
"preflight": [],
"dry_run_mode": []
},
"additionalProperties": true
}
]
},
"error": {
"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/release_project.py
- Documentation channel
- Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
- Availability
- 0.2.2.0.2 or earlier
Keep exploring
Related commands
These commands also belong to the development category. Compare them to choose the operation that best fits your task.
qzx projectLanguagesProfiles a project's source languages and supporting formats with line, file, and byte percentagesqzx scaffoldCCreates a basic scaffolding for a C programqzx projectDoctorInspects project health: detects tech stack, dependencies, environment configuration, Git state, test suites, circular imports, dead code, and large filesqzx scaffoldCppCreates a basic scaffolding for a C++ program