Gerador de Changelog

Escrever changelogs à mão significa vasculhar o git log a cada lançamento. Este gerador pula essa etapa: você cola as entradas que quer publicar diretamente na categoria certa, Added, Changed, Fixed e Removed, informa um número de versão e uma data, e ele produz uma seção markdown no estilo Keep a Changelog pronta para entrar no CHANGELOG.md. O mesmo conteúdo também pode ser gerado como texto simples. Ele não lê seu histórico do git; você decide quais mudanças entram no lançamento.

Como gerar um changelog

  1. 1

    Informe a versão e a data

    Digite o número da versão, por exemplo 1.2.0. Deixe a data em branco para usar a data de hoje.

  2. 2

    Adicione entradas por categoria

    Cole as notas de lançamento em Added, Changed, Fixed e Removed, uma entrada por linha. Categorias vazias são ignoradas.

  3. 3

    Escolha o formato de saída

    Markdown (um cabeçalho `## [versão] - data` com seções no estilo `### Added`) ou texto simples (um cabeçalho `v1.2.0 (data)` com listas com marcadores).

  4. 4

    Copie o changelog

    Cole a saída acima da entrada anterior no CHANGELOG.md.

As quatro categorias

O gerador produz exatamente quatro seções, nesta ordem: Added, Changed, Fixed e Removed. Os cabeçalhos de seção da saída permanecem em inglês, o padrão do Keep a Changelog.

Categoria Quando usar
Added Novos recursos
Changed Mudanças na funcionalidade existente
Fixed Correções de bugs
Removed Recursos removidos

A convenção Keep a Changelog também prevê as seções Deprecated, Security e Breaking. O gerador não tem campos para elas; você pode adicionar essas seções manualmente depois de colar a saída.

Exemplo de saída (Markdown)

## [1.4.0] - 2026-04-18

### Added
- Dark mode support for the dashboard (#312)
- CSV export on the users page (#318)

### Changed
- Upgrade React to 18.3 (#320)
- Pagination now defaults to 50 items per page (#322)

### Fixed
- Crash when editing users with a null email (#319)
- Timezone offset in scheduled reports (#321)

### Removed
- Legacy reports API (#324)

Exemplo de saída (texto simples)

v1.4.0 (2026-04-18)
ADDED:
  • Dark mode support for the dashboard (#312)
  • CSV export on the users page (#318)
CHANGED:
  • Upgrade React to 18.3 (#320)
  • Pagination now defaults to 50 items per page (#322)
FIXED:
  • Crash when editing users with a null email (#319)
  • Timezone offset in scheduled reports (#321)
REMOVED:
  • Legacy reports API (#324)

Dicas

  • Uma entrada por linha. Cada linha de um campo vira um marcador. Campos vazios são ignorados e você pode deixar uma categoria inteira sem conteúdo.
  • Escreva as entradas como linhas do changelog, não como anotações de log. O imperativo “fix: handle null email on edit” funciona bem como marcador.
  • Referencie números de issue/PR para que os leitores possam se aprofundar: (#319) ou [#319](link) na saída.
  • Uma versão por entrada: não combine dois lançamentos em um único bloco, mesmo que estejam a um dia de distância.
  • Lançado ou não lançado: mantenha uma seção [Não lançado] no topo com mudanças destinadas à próxima versão. Mova-as para uma seção com data no lançamento.

Perguntas frequentes

As convenções de Keep a Changelog (keepachangelog.com): um cabeçalho de versão com data e listas com marcadores agrupadas. O gerador emite as seções Added, Changed, Fixed e Removed; as demais seções padrão (Deprecated, Security, Breaking) seguem a mesma convenção se você as adicionar manualmente.

O gerador produz as quatro seções principais: Added, Changed, Fixed e Removed. Não há campos dedicados para Deprecated, Security ou Breaking, mas você pode adicionar essas seções manualmente ao texto gerado antes de colá-lo.

O gerador é uma ferramenta de interface de uso único; para automação, use um CLI como standard-version, release-please ou semantic-release, que implementam os mesmos padrões no seu pipeline de build.

Não. Ele não lê seu repositório nem suas mensagens de commit; você mesmo cola as entradas. O texto que você digita é enviado ao servidor para construir a saída e não é armazenado nem compartilhado.

Ferramentas relacionadas