changelog

Sobre changelog

A habilidade “ changelog ” automatiza o processo de geração de entradas no arquivo ` changelog ` a partir dos commits do Git realizados desde o último lançamento. Ela foi projetada para ajudar as equipes de desenvolvimento a manter um registro consistente e focado no usuário das alterações em seus projetos. Ao analisar mensagens de commit e distinguir entre alterações visíveis ao usuário e alterações internas, essa skill garante que o arquivo CHANGELOG.md reflita atualizações significativas e relevantes para os usuários finais. Isso reduz o trabalho manual, evita que alterações sejam ignoradas e garante que a documentação de lançamento permaneça precisa e atualizada.

A skill oferece um fluxo de trabalho estruturado para extrair informações de commits, categorizar alterações e formatar entradas em um estilo padronizado. Os principais recursos incluem a identificação de alterações voltadas para o usuário, como novos recursos, correções de bugs, melhorias de desempenho, descontinuações e atualizações de segurança, ao mesmo tempo em que exclui alterações puramente internas, como refatoração, testes ou modificações de CI/CD. Ela extrai automaticamente referências a issues a partir de mensagens de commit e organiza as entradas em categorias predefinidas (Adicionado, Alterado, Corrigido, Removido, Obsoleto, Segurança). Além disso, determina a seção apropriada do changelog com base no branch atual, oferecendo suporte tanto a versões lançadas quanto a uma seção “Não lançado”. A skill utiliza comandos Bash e a ferramenta Edit para ler e atualizar o changelog de maneira integrada.

Essa skill é ideal para desenvolvedores, gerentes de lançamento e equipes que mantêm projetos de software de código aberto ou internos e desejam otimizar a manutenção do changelog. É especialmente útil para projetos com commits frequentes ou vários colaboradores, pois garante que todas as alterações relevantes para o usuário sejam documentadas de forma consistente. Os usuários se beneficiam da economia de tempo, da redução de erros e de um “ changelog ” profissional e estruturado, que comunica as atualizações de forma clara aos usuários finais, partes interessadas e colaboradores.

Perguntas frequentes

Como uso a skill “ changelog ”?

Comece executando a skill no repositório do seu projeto. Ela detectará automaticamente os commits desde o último lançamento, categorizará as alterações visíveis ao usuário, extrairá referências a issues e atualizará o arquivo ` CHANGELOG.md` na seção apropriada (Lançamento não publicado ou lançamento versionado).

Que tipos de alterações estão incluídas no ` changelog`?

A skill inclui alterações visíveis ao usuário, como novos recursos, correções de bugs, melhorias de desempenho, alterações compatíveis, descontinuações e correções de segurança. Alterações internas, como refatoração, testes, CI/CD ou atualizações de estilo de código, são excluídas, a menos que afetem o comportamento visível ao usuário.

Ela consegue lidar com repositórios sem tags de lançamento anteriores?

Sim, se não houver nenhuma tag de lançamento anterior, a skill analisa os commits mais recentes (até 50) para gerar entradas de “ changelog ” e as coloca na seção “Não lançado”.

Ele mescla automaticamente novas entradas com o conteúdo existente do ` changelog `?

Sim, a skill lê o arquivo .md atual de “ CHANGELOG ”, cria a seção de destino caso ela não exista e mescla as novas entradas, evitando duplicatas.

As referências a issues são obrigatórias nas mensagens de commit?

Não, as referências a issues são opcionais. Quando presentes, elas são incluídas na entrada no formato ‘(#123)’. Várias referências são mescladas como ‘(#123, #124)’.