desenvolvimento · Referência do comando
qzx prepareRelease
O que faz
Planeja a atualização dos metadados de uma versão e pode modificar atomicamente um manifesto e CHANGELOG.md; nunca compila, faz commit, cria tag nem publica.
Maturidade do comando: Alpha
Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.9. A documentação corresponde ao checkout alpha 0.2.2.0.9.
Comportamento e proteções integradas
O modo real aplica as alterações solicitadas
Prévia disponível
Usa uma ferramenta nativa quando necessário
Funciona sem usar a rede
Usa suas permissões atuais; o resultado pode variar
A prévia é o comportamento padrão. Para aplicar, é exigido um backup do projeto com proteção contra falhas, um único manifesto inequívoco, notas revisadas quando o changelog for atualizado e, por padrão, uma árvore Git limpa. Nunca executa testes, builds, commits, tags, publicações nem deploys.
O QZX cria um arquivo de recuperação antes das alterações reais; use --dangerously-bypass-approvals-and-sandbox/--yolo somente quando decidir ignorá-lo deliberadamente.
Esta classificação de segurança foi revisada por OpenAI GPT-5.6 Pro em relação ao digest de implementação sha256:50bb166bd5377dc55fb00399daa06e678700dee990c8e0069b2b75e14bd88a7f em 2026-08-25.
Sintaxe exata
qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --jsonParâmetros
Deslize ou use a barra horizontal para ver todas as colunas.
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| bump | str | Não | "patch" | Incremento da versão: patch, minor ou major |
| path | str | Não | "." | Diretório do projeto que será preparado |
| dry_run | bool | Não | true | Visualiza as alterações exatas de metadados sem gravá-las |
| new_version | str | Não | Não declarado | Versão de destino explícita; recomendada para pré-releases e projetos que não usam SemVer de três partes |
| release_notes | str | Não | Não declarado | Texto do changelog já revisado; obrigatório ao aplicar com update_changelog=true |
| update_changelog | bool | Não | true | Adiciona ao início de CHANGELOG.md uma entrada revisada |
| require_clean_git | bool | Não | true | Exige que o projeto tenha uma árvore de trabalho Git limpa antes de aplicar alterações |
| manifest | str | Não | Não declarado | Caminho explícito de um manifesto compatível dentro do projeto quando a detecção automática for ambígua |
Exemplos de entrada
qzx prepareReleaseVisualizar a próxima versão patch e todas as precondições de preparação
qzx prepareRelease --new-version 2.0.0rc1 --release-notes "Release candidate with reviewed fixes" --dry-run falseFazer backup de um projeto limpo e preparar atomicamente uma pré-release explícita de Python sem criar commit nem tag
Para obter o payload estruturado completo, adicione --json: qzx prepareRelease [bump] [path] [dry_run] [new_version] [release_notes] [update_changelog] [require_clean_git] [manifest] --json
Exemplo de saída representativa
Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.
Comando do exemplo: 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"
}Ver o 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"
},
"details": [],
"dry_run": {
"type": "boolean"
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"plan": [],
"status": {
"type": "string"
}
},
"additionalProperties": true
}Erros e limites
O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.
O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.
Fluxo de evidência: requer um ambiente privilegiado controlado.
Evidência e procedência
- Implementação
- src/qzx/commands/development/prepare_release.py
- Canal de documentação
- Documentação de desenvolvimento 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
- Disponibilidade
- 0.2.2.0.9 ou anterior
Continue explorando
Comandos relacionados
Estes comandos também pertencem à categoria desenvolvimento. Compare-os para escolher a operação que melhor resolve sua tarefa.
qzx planProjectBootstrapCria um plano selecionável para iniciar um projeto sem gravar arquivos, instalar dependências, criar segredos ou executar migrações.qzx projectLanguagesPerfila as linguagens-fonte e formatos auxiliares de um projeto com percentuais por linhas, arquivos e bytes.qzx getProjectTreeGera uma árvore limitada em ASCII e JSON sem seguir links simbólicos descendentes.qzx scaffoldCCria uma estrutura básica para um programa em C.