feat(ci): automatiza geração do CHANGELOG com git-cliff #631
Conversation
| 📌 Esta mensagem está tanto em português quanto em inglês (mais abaixo) — assim todo mundo consegue acompanhar! 🇧🇷 Português 👋 Olá! Este PR está obsoleto porque ficou aberto por 30 dias sem atividade. Remova o rótulo de stale ou comente, caso contrário ele será fechado em 15 dias. 🇬🇧 English Hey there! 👋 This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 15 days. |
morais90 force-pushed the feature/git-cliff-integration branch 2 times, most recently from 36ae31c to a412032 Compare 
Implementa automação completa do CHANGELOG.md através de workflows do GitHub Actions. Agora, a cada merge na branch main, o CHANGELOG é atualizado automaticamente na seção Unreleased. Para criar releases, basta executar o workflow que detecta a próxima versão e gera um PR com todas as mudanças organizadas. Remove a necessidade de edição manual do CHANGELOG pelos contribuidores, que agora apenas precisam seguir o padrão de Conventional Commits nas mensagens de commit. A documentação foi atualizada para refletir o novo processo automatizado.
morais90 force-pushed the feature/git-cliff-integration branch from a412032 to 25379ca Compare | 📌 Esta mensagem está tanto em português quanto em inglês (mais abaixo) — assim todo mundo consegue acompanhar! 🇧🇷 Português 👋 Olá! Este PR está obsoleto porque ficou aberto por 30 dias sem atividade. Remova o rótulo de stale ou comente, caso contrário ele será fechado em 15 dias. 🇬🇧 English Hey there! 👋 This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 15 days. |
1 participant
Descrição
Este PR automatiza completamente a geração do CHANGELOG.md usando git-cliff. A partir de agora, o CHANGELOG é atualizado automaticamente sempre que um PR é mesclado na main.
Os contribuidores não precisam mais editar o CHANGELOG manualmente. Basta seguir o padrão de Conventional Commits nas mensagens de commit que o resto acontece automaticamente.
Mudanças Propostas
Implementa workflow
Update Changelogque atualiza a seçãoUnreleaseddo CHANGELOG automaticamente após cada merge.A documentação foi atualizada para refletir o novo processo, removendo as instruções de edição manual do CHANGELOG e enfatizando a importância de seguir Conventional Commits.
Checklist de Revisão
Comentários Adicionais (opcional)
Para testar localmente, é possível instalar o git-cliff e executar
make changelog. O comando já inclui uma mensagem de ajuda caso a ferramenta não esteja instalada.É importante notar que este PR requer a configuração de dois secrets no repositório (
APP_CHANGELOG_IDeAPP_CHANGELOG_PRIVATE_KEY) para permitir que o workflow atualize o CHANGELOG na branch protegida.Issue Relacionada
Closes #469