Skip to content

Conversation

@morais90
Copy link
Contributor

@morais90 morais90 commented Oct 23, 2025

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 Changelog que atualiza a seção Unreleased do 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

  • Eu li o Contributing.md
  • Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
  • Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
  • A documentação em português foi atualizada ou criada, se necessário.
  • Se feita a documentação, a atualização do arquivo em inglês.
  • Eu documentei as minhas mudanças no código, adicionando docstrings e comentários.
  • O código segue as diretrizes de estilo e padrões de codificação do projeto.
  • Todos os testes passam.
  • O Pull Request foi testado localmente.
  • Não há conflitos de mesclagem.

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_ID e APP_CHANGELOG_PRIVATE_KEY) para permitir que o workflow atualize o CHANGELOG na branch protegida.

Issue Relacionada

Closes #469

@morais90 morais90 requested review from a team as code owners October 23, 2025 12:58
@morais90 morais90 marked this pull request as draft October 23, 2025 12:59
@github-actions
Copy link

📌 Esta mensagem está tanto em português quanto em inglês (mais abaixo) — assim todo mundo consegue acompanhar!
📌 This message is in both Portuguese and English (further down) — so everyone can follow along!

🇧🇷 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.

@github-actions github-actions bot added the Stale label Nov 23, 2025
@morais90 morais90 force-pushed the feature/git-cliff-integration branch 2 times, most recently from 36ae31c to a412032 Compare November 23, 2025 11:00
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 morais90 force-pushed the feature/git-cliff-integration branch from a412032 to 25379ca Compare November 23, 2025 11:02
@morais90 morais90 marked this pull request as ready for review November 23, 2025 11:02
@github-actions github-actions bot removed the Stale label Nov 24, 2025
@github-actions
Copy link

📌 Esta mensagem está tanto em português quanto em inglês (mais abaixo) — assim todo mundo consegue acompanhar!
📌 This message is in both Portuguese and English (further down) — so everyone can follow along!

🇧🇷 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.

@github-actions github-actions bot added the Stale label Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adaptar Changelog para Evitar Conflitos de Merge em Mudanças Simultâneas

1 participant