跳到主要内容

开发 · 命令参考

qzx prepareRelease

作用

规划版本元数据更新,并可原子修改清单和 CHANGELOG.md;绝不会构建、提交、打标签或发布。

命令成熟度:Alpha

可用于真实使用和反馈,但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.9 使用。文档对应 alpha checkout 0.2.2.0.9。

行为与内置保护

实际模式会应用你请求的更改

提供预览

需要时使用原生工具

无需网络即可运行

使用你当前的权限;结果可能有所不同

默认行为是预览。应用时要求带故障保护的项目备份、唯一明确的清单、更新 changelog 时已审阅的说明,以及默认情况下干净的 Git 工作树。绝不会执行测试、build、commit、tag、发布或部署。

QZX 会在实际更改前创建恢复文件;只有在你明确决定故意跳过它时才使用 --dangerously-bypass-approvals-and-sandbox/--yolo。

此安全分类由 OpenAI GPT-5.6 Pro 于 2026-08-25 对照实现摘要 sha256:50bb166bd5377dc55fb00399daa06e678700dee990c8e0069b2b75e14bd88a7f 审阅。

准确语法

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

参数

滑动或使用横向滚动条查看所有列。

名称类型必填默认值描述
bumpstr"patch"版本增量:patch、minor 或 major
pathstr"."要准备的项目目录
dry_runbooltrue预览精确的元数据更改而不写入
new_versionstr未声明明确的目标版本;推荐用于预发布和不使用三段式 SemVer 的项目
release_notesstr未声明已审阅的 changelog 文本;使用 update_changelog=true 应用时必填
update_changelogbooltrue在 CHANGELOG.md 顶部添加已审阅条目
require_clean_gitbooltrue应用更改前要求项目具有干净的 Git 工作树
manifeststr未声明自动检测存在歧义时,项目内兼容清单的明确路径

输入示例

qzx prepareRelease

预览下一个 patch 版本及所有准备前提条件

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

备份干净项目,并在不创建 commit 或 tag 的情况下原子准备明确的 Python 预发布版本

要获得完整结构化载荷,请添加 --json: qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --json

代表性输出示例

此示意 JSON 源自当前实现所支持的结果契约。它展示命令可能返回的内容,并不声称这是录制的实际执行;具体值会随输入、设备、权限和可选工具而变化。

示例命令: 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,
    "details": {
        "summary": "Additional structured context is included here."
    },
    "dry_run": true,
    "plan": "Example value",
    "status": "ok"
}
查看 JSON 结果契约
{
    "$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"
        },
        "details": [],
        "dry_run": {
            "type": "boolean"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "plan": [],
        "status": {
            "type": "string"
        }
    },
    "additionalProperties": true
}

错误与限制

公开契约要求失败时返回 success=false 和具有描述性的 message。此目录尚未为每个命令声明专门的错误分类;请检查结果,不要推断不存在的错误码。

QZX 仍处于 alpha 阶段。可选依赖、权限和主机能力可能影响结果。

证据流程:需要受控的特权环境。

证据与来源

文档渠道
开发文档 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
可用性
0.2.2.0.9 或更早

继续探索

这些命令同样属于 开发 类别。对比它们,选择最适合解决任务的操作。

浏览所有 QZX 命令