desarrollo · Referencia de comando

`qzx prepareRelease`

Qué hace

Planifica la actualización de metadatos de una versión y puede modificar atómicamente un manifiesto y CHANGELOG.md; nunca construye, confirma, etiqueta ni publica.

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.6a11. La documentación corresponde al checkout alpha 0.2.2.0.6a11.

Seguridad y efectos

Puede modificar estado

Parámetro dry-run documentado

Puede invocar programas nativos

Sin uso de red documentado

El resultado puede depender de permisos

La previsualización es el comportamiento predeterminado. Para aplicar se exige un respaldo del proyecto con protección ante fallos, un único manifiesto inequívoco, notas revisadas cuando se actualiza el changelog y, de forma predeterminada, un árbol Git limpio. Nunca ejecuta pruebas, builds, commits, tags, publicaciones ni despliegues.

Antes de mutar, QZX crea un archivo de recuperación; --dangerously-bypass-approvals-and-sandbox/--yolo lo omite explícitamente.

Esta clasificación de seguridad fue revisada por OpenAI Codex (authorized project audit) contra el digest de implementación sha256:c58bca7394f654c198695cd00e4469fa7405f407649bb8da41758359bb3450e9 el 2026-07-30.

Sintaxis exacta

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

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
bump	str	No	"patch"	Incremento de versión: patch, minor o major
path	str	No	"."	Directorio del proyecto que se preparará
dry_run	bool	No	true	Previsualiza los cambios exactos de metadatos sin escribirlos
new_version	str	No	No declarado	Versión de destino explícita; se recomienda para pre-releases y proyectos que no usan SemVer de tres partes
release_notes	str	No	No declarado	Texto del changelog ya revisado; se requiere al aplicar con update_changelog=true
update_changelog	bool	No	true	Añade al inicio de CHANGELOG.md una entrada revisada
require_clean_git	bool	No	true	Exige que el proyecto sea un árbol de trabajo Git limpio antes de aplicar cambios
manifest	str	No	No declarado	Ruta explícita de un manifiesto compatible dentro del proyecto cuando la detección automática resulte ambigua

Ejemplos de entrada

qzx prepareRelease

Previsualizar la próxima versión patch y todas las precondiciones de preparación

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

Respaldar un proyecto limpio y preparar atómicamente una pre-release explícita de Python sin crear commit ni tag

Para obtener la carga estructurada completa, añade --json: qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: 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"
}

Ver el contrato de resultado 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"
        },
        "dry_run": {
            "type": "boolean"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "plan": [],
        "status": {
            "type": "string"
        }
    },
    "additionalProperties": true
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un entorno privilegiado controlado.

Evidencia y procedencia

Implementación: src/qzx/commands/development/prepare_release.py
Pruebas: tests/test_development_commands/test_prepare_release.py
Canal de documentación: Documentación de desarrollo 0.2.2.0.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Disponibilidad: 0.2.2.0.6a11 o anterior

Sigue explorando

Estos comandos también pertenecen a la categoría de desarrollo. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX