Fazemos uma das ferramentas nesta página. Tentamos descrever as outras pelo que foram construídas para fazer, não por onde ficam aquém, e a seção sobre nosso próprio produto diz claramente quem não deveria usá-lo.
As três categorias
Widget e página hospedados
Você escreve entradas no editor deles, eles hospedam a página e te dão um widget no app. O mais rápido para lançar, e as entradas vivem na infraestrutura deles, não na sua. Beamer e AnnounceKit são os exemplos mais claros.
Pacote de feedback com changelog embutido
O changelog é um módulo ao lado de votação de funcionalidades, um roadmap público e uma caixa de feedback. Vale a pena se você quer todo o loop de um único fornecedor, exagerado se só quer publicar notas de versão. Canny, Frill e Featurebase estão aqui.
Gerado a partir do seu repositório
O changelog é produzido a partir de commits, pull requests ou issues em vez de digitado à mão. Varia de um arquivo construído no CI a uma entrada redigida, revisada e publicada. git-cliff e github-changelog-generator ficam na ponta do arquivo; LaunchNotes, Released e nosso próprio produto ficam na ponta publicada.
Em resumo
| Ferramenta | Tipo | Melhor para |
|---|---|---|
| Beamer | Widget hospedado | Colocar no ar ainda esta tarde um painel de novidades dentro do app, sem tempo de engenharia. |
| AnnounceKit | Widget hospedado | O mesmo, com mais atenção à segmentação de quem vê cada anúncio. |
| Canny | Pacote de feedback | Equipes que querem votação de funcionalidades e um roadmap público, com o changelog como etapa final desse loop. |
| Frill | Pacote de feedback | Equipes menores que querem o mesmo formato do Canny, só que mais leve. |
| LaunchNotes | Gerado do repositório | Organizações maiores coordenando anúncios entre equipes, muitas vezes com o Jira como base. |
| Released | Gerado do repositório | Equipes que vivem no Jira e querem o changelog produzido a partir das issues sem sair dele. |
| git-cliff | Gerador de arquivo | Projetos de código aberto que querem um CHANGELOG.md gerado a partir de conventional commits no CI, sem nada hospedado. |
| Changeloop | Gerado do repositório | Equipes que querem a entrada elaborada a partir de pull requests mesclados e depois renderizada pelo próprio front end a partir de um feed JSON. |
Como escolher
- Comece por onde o changelog precisa aparecer. Se precisa parecer parte do seu produto, uma página hospedada para a qual você linka vai decepcionar não importa quão bom seja o editor, e você quer ou um widget que possa restilizar ou um feed que renderize. Se uma página com link está tudo bem, as ferramentas hospedadas dão muito menos trabalho.
- Depois pergunte quem escreve as entradas. Se a resposta for "o engenheiro que fez o merge", escolha algo que leia seu repositório, porque qualquer outra coisa adiciona um passo manual bem no momento em que todos estão ocupados. Se a resposta for um profissional de marketing de produto trabalhando a partir de um plano de lançamento, um editor se encaixa melhor e a automação de repositório só vai atrapalhar.
- Depois pergunte se você precisa do resto do loop. Votação de funcionalidades e um roadmap público são genuinamente úteis e genuinamente um compromisso maior. Comprar um pacote pelo módulo de changelog é como equipes acabam pagando por quatro coisas para usar uma.
- Por último, verifique o que acontece com suas entradas se você sair. Uma ferramenta que vai exportá-las como dados estruturados é materialmente diferente de uma onde elas vivem em uma página hospedada que você teria que raspar.
Onde nossa própria ferramenta se encaixa, e onde não
O Changeloop lê cada pull request mesclado, redige uma entrada voltada ao usuário, filtra atualizações de dependências e refactors, e segura o rascunho para revisão. O que é publicado vai para um feed JSON público com um feed de roadmap ao lado, além de um widget de duas linhas e uma página hospedada como recursos alternativos. O feed é o ponto principal: a configuração pretendida é você renderizar seu changelog dentro do seu próprio produto com seus próprios componentes.
Não escolha se:
- Seus lançamentos não vêm dos seus repositórios. Ele redige a partir de merges ou, no modo push, de pushes, então uma equipe que entrega fora de um fluxo de trabalho com Git não tem nada para revisar.
- Você quer votação de funcionalidades e um roadmap em que seus usuários votam. Existe um feed de roadmap, mas é movido por issues rotuladas, não por votação de usuários. Um pacote de feedback é a categoria certa para isso.
- Você quer um editor polido e uma página hospedada como o produto principal. A página hospedada existe como recurso alternativo, e as ferramentas construídas em torno da delas vão fazer isso melhor.
- Você é um projeto de código aberto individual que só quer um CHANGELOG.md no repositório. Use o git-cliff, que é grátis e feito exatamente para isso.
Perguntas frequentes
Precisamos de uma ferramenta, afinal?
Por um tempo, não. Um arquivo markdown, ou uma página no seu próprio site, é um changelog perfeitamente bom e não custa nada. O ponto em que uma ferramenta começa a compensar é quando escrever as entradas é o passo que fica sendo pulado, ou quando você quer as mesmas entradas em três lugares sem manter três cópias.
Podemos migrar de uma dessas depois?
Depende inteiramente se as entradas saem de volta como dados estruturados. Pergunte antes de começar, não depois: essa é a única pergunta da lista que é cara de errar, porque um changelog é um arquivo em crescimento e redigitar dois anos dele não é um projeto que ninguém aprova.
E escrever essas entradas com um assistente de IA?
A maioria delas agora redige com um modelo em algum lugar. Importa menos do que o modelo recebe. Uma ferramenta que só vê um assunto de commit só consegue reescrever esse assunto; uma que vê o título e a descrição do pull request tem o suficiente para descrever a mudança em termos do que ela faz para um usuário. Pergunte qual é a entrada, não se há IA.
Leitura adicional: automação de changelog, e seus limites, sobre qual dos quatro passos deveria ser automático.
A que prioriza o feed
Redigida a partir dos seus pull requests mesclados, segurada para revisão, publicada em um feed JSON que você mesmo renderiza. Grátis para um repositório, sem cartão.
Começar grátis