Skip to content
Latchkey

O Que É um Build Badge? A Imagem de Status no Seu README

Um build badge é uma pequena imagem de status ao vivo, geralmente em um README, que mostra num relance se o pipeline mais recente está passando ou falhando.

Você já viu aquelas pequenas pílulas "build: passing" no topo de um repositório. Isso é um build badge. É uma imagem que o sistema de CI gera dinamicamente, refletindo o status atual do pipeline de um branch. Badges dão aos visitantes confiança instantânea (ou aviso) sobre a saúde de um projeto sem abrir o dashboard de CI.

Como um badge funciona

O badge é uma URL de imagem servida pelo provedor de CI. Cada vez que a página carrega, o provedor renderiza a imagem para corresponder ao status da execução mais recente: verde para passing, vermelho para failing. O README apenas incorpora essa URL.

O que um badge mostra

  • Pass ou fail da execução mais recente em um branch.
  • Frequentemente o nome do workflow ou job.
  • Às vezes coverage, versão ou outras métricas ao vivo.

Um exemplo rápido

No GitHub Actions você incorpora !CI no seu README. Ele rastreia o branch padrão e atualiza automaticamente após cada execução.

Badges para confiança e visibilidade

Para projetos open-source, um badge verde sinaliza uma base de código saudável e mantida. Para repositórios internos, badges colocam o status onde os desenvolvedores já olham, reduzindo idas à UI de CI.

Limites dos badges

Um badge é um resumo, não um diagnóstico. Ele diz pass ou fail, não o porquê. E um badge verde de um pipeline instável pode enganar, então trate o badge como uma manchete e os logs da execução como a história real.

Principais conclusões

  • Um build badge é uma imagem de status ao vivo mostrando pass ou fail para um branch.
  • O provedor de CI o renderiza dinamicamente; o README apenas incorpora a URL.
  • É um resumo rápido, não um substituto para ler os logs da execução.

Guias relacionados