O Que É um Job Summary no GitHub Actions?
Um job summary é Markdown que um step escreve em um arquivo especial, que o GitHub renderiza na página da execução para resultados de relance.
Logs são ruidosos. Job summaries permitem que um step publique um relatório Markdown limpo, como uma tabela de testes ou número de cobertura, diretamente na página da execução, para que revisores vejam os resultados sem rolar pela saída.
O que é
Um job summary é conteúdo anexado ao path de arquivo armazenado na variável de ambiente GITHUB_STEP_SUMMARY. O GitHub o renderiza como Markdown na página do workflow run.
steps:
- run: |
echo "## Test results" >> "${GITHUB_STEP_SUMMARY}"
echo "- Passed: 42" >> "${GITHUB_STEP_SUMMARY}"Como funciona
Qualquer step pode anexar Markdown ao arquivo GITHUB_STEP_SUMMARY. O GitHub os coleta por job e os exibe juntos, suportando tabelas, listas, imagens e mais.
Usos comuns
- Tabelas de aprovação/falha de testes e números de cobertura.
- URLs de deployment e números de versão.
- Links para artifacts ou dashboards externos.
Por que importa
Summaries transformam logs brutos em um relatório legível, acelerando a revisão e a triagem. São a forma mais limpa de expor o único número que um revisor realmente se importa.
Conceitos relacionados
Job summaries usam um arquivo especial como o GITHUB_ENV faz e complementam artifacts para compartilhar resultados da execução.
Principais conclusões
- Um job summary é Markdown escrito em
GITHUB_STEP_SUMMARY. - Ele é renderizado na página da execução para resultados de relance.
- Ele suporta tabelas, listas, links e imagens.