Release do ClickUpfy
Conduza releases reproduzíveis sem criar tags ou alterar versões manualmente.
O Release Please é a fonte da versão, do changelog, da tag e da GitHub
Release. O GitHub Actions compila e publica os artefatos após a criação da
release.
Cobertura documental da release
Confira se todo comando, parâmetro, ferramenta MCP e comportamento público da
versão está explicado em
. O manual precisa detalhar entradas,
saídas, permissões, efeitos persistentes, limitações da API e cinco exemplos
diferentes por comando ou ferramenta. Leia também
docs/user/reading-order.txt
para confirmar que cada capítulo aparece uma vez no PDF e no EPUB.
Quando houver mudança documental, confirme
, execute
, execute
e publique os artefatos que o
manifesto resultante declarar. Não libere versão cujo texto de ajuda tenha
mudado sem a referência correspondente no manual.
Antes de começar
- Trabalhe dentro do repositório independente .
- Leia e confira .
- Preserve mudanças locais que não pertençam à release.
- Execute quando as dependências ainda não estiverem instaladas.
- Não crie uma tag nem edite a versão diretamente, salvo em uma recuperação
explicitamente autorizada.
Preparar mudanças
Use Conventional Commits. O Release Please determina a próxima versão pelo
histórico desde a última release:
- propõe patch;
- propõe minor;
- ou propõe major;
- , , e entram no changelog sem forçar uma
versão maior que as mudanças funcionais presentes.
Antes de enviar as mudanças:
O comando verifica tipos, testes, build, versões, manifesto, changelog e
presença do workflow.
Publicar uma release
- Faça push dos Conventional Commits para .
- Aguarde o workflow criar ou atualizar a Release PR.
- Revise na PR a versão proposta e o .
- Faça merge da Release PR.
- Acompanhe a mesma execução do workflow até estes resultados:
- tag imutável ;
- GitHub Release;
- executáveis Linux x64, macOS x64, macOS arm64 e Windows x64;
- pacote publicado no registry npm;
- o mesmo pacote npm em arquivo na GitHub Release;
- ;
- attestations de proveniência quando o repositório for público.
Não rode
nem
no fluxo normal.
Validar localmente
Valide a coerência da versão atual:
bash
npm run release:check
npm run release:check -- v0.1.0
O segundo comando só deve usar a tag correspondente à versão atual. Gere e
teste o executável da plataforma local:
bash
npm run build:executable
./artifacts/clickupfy-v0.1.0-linux-x64/clickupfy --version
Adapte o nome do artefato à versão, plataforma e arquitetura exibidas pelo
script.
Diagnosticar falhas
- Release PR ausente: confira os gatilhos do workflow, as permissões de Actions
e se há Conventional Commits depois do ou da última tag.
- CI não executou na Release PR: configure o secret opcional
, conforme .
- Release criada sem binários: reexecute os jobs falhos da mesma execução.
- Publicação npm falhou: confirme o secret e reexecute o job; o
script ignora uma versão que já exista no registry.
- Artefato inválido: reproduza com , e
na plataforma afetada.
- Versão divergente: não corrija somente um arquivo. Inspecione
, ,
.release-please-manifest.json
,
e a tag.
Recuperar uma release
Não mova nem reutilize uma tag publicada. Para erro no código, envie um
Conventional Commit corretivo e publique uma nova patch release. Para arquivo
ausente ou job interrompido, reexecute o workflow no commit tagueado; o upload
usa substituição idempotente para os nomes daquela mesma release.
Só use operações manuais do GitHub CLI quando a automação não puder ser
recuperada e houver autorização explícita. Registre no handoff o motivo, a tag,
os arquivos substituídos e as validações executadas.