Skip to content

docs: reconciliar historico e formalizar governanca de releases (#123) - #207

Merged
BryanPinheiro77 merged 3 commits into
developfrom
docs/123-release-governance
Sep 16, 2026
Merged

BryanPinheiro77 merged 3 commits into
developfrom
docs/123-release-governance

Conversation

@BryanPinheiro77

Copy link
Copy Markdown
Owner

Objetivo

Corrigir o changelog e o roadmap que ficaram desatualizados após as releases, e formalizar sua manutenção durante o desenvolvimento e a promoção.

Alterações realizadas

  • Reconciliado histórico de v1.8.1 a v1.10.0 com as releases publicadas; corrigido título/link da 1.5.0 e consolidado conteúdo repetido da v1.8.3.
  • Separadas entregas publicadas, trabalho em andamento e pendências no roadmap.
  • Criado docs/releases.md com regras de versão, preparação, promoção, publicação por SHA, evidências e preservação de develop.
  • Atualizados template de PR, contribuição, índice e deploy; removida melhoria de health checks que já foi entregue.

Tipo de mudança

  • Documentação

Checklist de qualidade

  • O PR tem escopo pequeno e claro
  • Executei ./mvnw clean verify
  • Os testes automatizados passaram
  • Rodei análise local no SonarQube quando houve alteração relevante
  • O Quality Gate continua aprovado quando houve análise SonarQube
  • Não introduzi novas issues críticas de Security ou Reliability (revisão documental)
  • Mantive ou aumentei a cobertura de New Code quando houve código novo
  • Atualizei o CHANGELOG.md quando necessário
  • Atualizei o roadmap quando o estado de uma frente mudou
  • Em promoção: reconciliei versão, changelog, roadmap, issues e impactos operacionais conforme docs/releases.md
  • Atualizei o README.md ou documentação quando necessário
  • Verifiquei que não foram adicionados tokens, senhas ou secrets

Evidências

Dois commits: reconciliação do histórico e governança/checklists. Links locais verificados; versões reconciliadas presentes uma única vez; seções da v1.8.3 sem duplicatas; git diff --check aprovado.

Somente documentação: Maven e SonarQube não executados localmente. CI do PR executa API, bot e higiene. Nenhuma tag publicada foi alterada, nenhum deploy será acionado pelo merge em develop. A branch foi criada de main após #206 e também leva o merge de promoção de volta para develop.

A versão pública é a tag compartilhada pelos dois módulos. Os POMs continuam com versão técnica SNAPSHOT; essa distinção foi documentada. A verificação de coerência de roadmap/changelog permanece responsabilidade do autor e revisor, sem automação semântica nova.

Testes realizados

  • ./mvnw clean verify local
  • Testes unitários específicos
  • Teste manual: links locais e consistência das seções do histórico
  • Análise SonarQube local
  • git diff --check

Issue relacionada

Closes #123

@BryanPinheiro77
BryanPinheiro77 merged commit 2369cfe into develop Sep 16, 2026
3 checks passed
@BryanPinheiro77
BryanPinheiro77 deleted the docs/123-release-governance branch September 16, 2026 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant