Implementar um registo de alterações

  • 3 minutos

Um changelog é simples: é um arquivo que lista as alterações feitas em um projeto, geralmente organizadas por data. O formato típico mostra versões e, para cada versão, lista:

  • Recursos adicionados - Novas coisas que você pode fazer
  • Funcionalidades modificadas/aprimoradas - Aspectos que funcionam melhor
  • Recursos excluídos - Coisas que foram removidas

Algumas equipes postam changelogs como postagens de blog. Outros criam um arquivo CHANGELOG.md em seu repositório GitHub.

Ferramentas automatizadas de changelog

Embora você possa criar e manter registros de alterações manualmente, convém usar uma ferramenta automatizada para ajudá-lo. Pelo menos como ponto de partida.

Usando comandos nativos do Git

O git log comando pode ajudá-lo a criar conteúdo automaticamente. Por exemplo, crie uma nova seção por versão:

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Registo de alterações do Git

Uma ferramenta popular é o gitchangelog. Esta ferramenta é escrita em Python.

Gerador de changelog do GitHub

Outra ferramenta popular é chamada github-changelog-generator.

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

Esta ferramenta é baseada em Ruby Gem.

Você deve usar dados baseados em log gerados automaticamente?

Normalmente, é melhor evitar apenas copiar entradas de log em um changelog. Os logs contêm muitos detalhes técnicos, por isso é fácil criar uma confusão que não ajuda os usuários a entender o que mudou.