feat(ci): automatiza geração do CHANGELOG com git-cliff #631
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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, e a criação de releases também passa a ser automatizada através de um workflow simples.
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ção de dois workflows principais:
O primeiro atualiza a seção Unreleased do CHANGELOG automaticamente após cada merge. O segundo permite criar releases através de um simples clique no Actions, detectando automaticamente a próxima versão com base nos commits e gerando um PR pronto para revisão.
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