Standard version
Problema
- Especificar em cada versão de uma aplicação as features que foram desenvolvidas e o bugs que foram corrigidos
Desenvolver software pode virar uma tarefa complexa e quando não há organização. Um recurso que se utiliza é criar um arquivo de changelog
que guarda todas as modificações que aconteceram em determinada aplicação entre uma versão e outra. Mas criar este arquivo de logs pode ficar
complicado pois os devs corrigem as tarefas e acabam esquecendo de alterar o changelog
.
Solução
Em aplicações Node.js
é possível resolver este problema através de um package chamado standard-version
que através das mensagens dos commits
gera o arquivo de changelog
fazendo com que o desenvolvedor apenas tenha que adicionar um prefixo antes da mensagem do commit.
Utilização
Instalar o standard version com dependência de desenvolvedor
npm i --save-dev standard-version
Adicionar um npm run script
no package.json
{
"scripts": {
"release": "standard-version"
}
}
Para criar/atualizar o arquivo de changelog
apenas precisamos executar o comando npm run release
que um arquivo CHANGELOG.md
será criado na raiz do projeto.
Para que o standard-version
identifique as features e correções de bugs as mensagens de commit precisam dos seguintes prefixos:
fix(Usuários): Corrigido o bug ao entrar um novo usuário no momento X
feat(Autenticação): Autenticação do usuário através da JWT
que pode ser utilizado atraves de: