Automatização de Controle de Versão e Changelog

Publicado por mbarletaem

A gestão manual de versões e changelogs pode ser uma tarefa repetitiva, sujeita a erros e propensa a inconsistências. Com a crescente complexidade dos projetos modernos, a adoção de soluções automatizadas para controle de versão e geração de changelogs não é apenas uma boa prática, mas uma necessidade. Este artigo explora ferramentas como Standard Version e Semantic Release, que podem transformar seu fluxo de trabalho.

Por que Automatizar o Controle de Versão e Changelogs?

Veja os os benefícios de adotar tal prática:

  • Consistência: Garante que o versionamento segue o padrão SemVer (Versionamento Semântico), com X.Y.Z representando versões maiores (MAJOR), menores (MINOR) e correções (PATCH).
  • Eficiência: Reduz o trabalho manual ao atualizar versões e criar changelogs.
  • Transparência: Facilita a comunicação das mudanças feitas no código com a equipe e os usuários finais.
  • Menos erros: Automatiza tarefas repetitivas, reduzindo erros humanos.

Mensagens de Commit Padronizadas

A base para a automatização é adotar mensagens de commit padronizadas, como as definidas pelo Conventional Commits. Este formato categoriza as mudanças e permite que as ferramentas interpretem automaticamente qual parte do versionamento deve ser incrementada.

Exemplos de Mensagens de Commit:

  • feat: Adicionar suporte à autenticação OAuth (Incrementa MINOR).
  • fix: Corrigir bug no login (Incrementa PATCH).
  • feat!: Alterar comportamento padrão do login (Incrementa MAJOR, devido ao !, que indica “breaking change”).

Ferramentas Principais

1. Standard Version

O Standard Version é uma ferramenta simples e eficaz para projetos que desejam apenas automatizar o controle de versão e a geração de changelogs.

Principais Funcionalidades:

  • Incrementa a versão com base nas mensagens de commit.
  • Atualiza automaticamente o arquivo CHANGELOG.md.

Configuração do Standard Version:

1. Instale o pacote:

      npm install --save-dev standard-version

      2. Adicione o script ao package.json

      "scripts": {
  "release": "standard-version"
}

      3. Use mensagens de commit padronizadas e, ao final do ciclo de desenvolvimento, execute:

      npm run release

      Vamos entender o que o comando acima faz por trás das cortinas:

      • Incrementa a versão no package.json.
      • Atualiza o changelog.
      • Cria uma tag Git.

      5. Publique as alterações:

      git push --follow-tags

      2. Semantic Release

      O Semantic Release leva a automatização para o próximo nível, integrando-se ao pipeline de CI/CD. Ele não apenas incrementa versões e gera changelogs, mas também realiza automaticamente o deploy de novas versões.

      Principais Funcionalidades:

      • Totalmente automatizado: cria tags, atualiza changelogs e faz deploy no CI/CD.
      • Suporte a integrações com GitHub Actions, Azure DevOps, GitLab, entre outros.

      Configuração do Semantic Release:

      1. Instale os pacotes necessários:

      npm install --save-dev semantic-release @semantic-release/changelog @semantic-release/git

      2. Configure o arquivo .releaserc:

      {
  "branches": ["main"],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    [
      "@semantic-release/git",
      {
        "assets": ["package.json", "CHANGELOG.md"],
        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
      }
    ]
  ]
}

      3. Integre no pipeline de CI/CD (exemplo com GitHub Actions):

      name: Release

on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '20.x'
      - run: npm ci
      - run: npx semantic-release

      4. Realize commits padronizados, e o Semantic Release cuidará do restante ao realizar o push para a branch main.

      Melhores Práticas

      1. Adoção de Conventional Commits:
        • Treine sua equipe para seguir o padrão nas mensagens de commit.
        • Considere usar ferramentas como Commitizen para guiar a escrita de commits.
      2. Automatize com CI/CD:
        • Configure pipelines que incluam o controle de versão e o deploy automatizado.
        • Use ferramentas como GitHub Actions, GitLab CI/CD ou Azure Pipelines.
      3. Integre no fluxo de trabalho:
        • Combine o Semantic Release com ferramentas de lint como Husky e Commitlint para validar commits antes de enviá-los ao repositório.
      4. Revise regularmente:
        • Periodicamente avalie se o versionamento e os changelogs refletem a realidade do projeto.

      Conclusão

      A automatização do controle de versão e changelogs não é apenas uma tendência, mas uma necessidade em projetos modernos. Ferramentas como Standard Version e Semantic Release garantem consistência, transparência e produtividade, permitindo que você e sua equipe foquem no que realmente importa: entregar valor aos usuários. Experimente essas soluções e transforme o fluxo de trabalho do seu time hoje mesmo!

      Espero que esse post tenha despertado para novas pesquisas! E para finalizar, não deixe de ler outros conteúdos aqui no blog:

      Deixe um comentário