Aprenda a adicionar Badges que mostram a cobertura de teste do seu projeto Java no GitHub
Introdução
Os Badges (ou Emblemas) do GitHub ajudam a aumentar a legibilidade dos seus projetos porque fornecem aos usuários uma maneira rápida e pratica de observar as métricas, como, status da build, percentual de cobertura de testes e a licença que é utilizada.
Pré-requisitos
Para adicionar o badge de cobertura de testes seguindo esse tutorial precisamos ter um projeto que esteja hospedado no GitHub utilizando Maven, e Java na versão 1.8 ou superior e ter feito o setup do jacoco.
Configuração do repositório
Você deve criar uma nova Action, para isso na pagina inicial do seu projeto acesse:
Actions -> New Workflow -> Set up a workflow yourself
Você deve alterar o conteúdo dessa nova action para ficar semelhante ao exemplo abaixo:
Observação: O valor da propriedade jacoco-csv-file deve corresponder ao path em que o jacoco foi configurado para gerar os relatórios no seu projeto.Gerando o Badge
Após ter criado a action vamos precisar executa-lá manualmente, para isso na pagina inicial do seu projeto acesse:
Actions -> Coverage Badge Generator -> Run Workflow
Quando a execução for finalizada, um novo pull request será criado no seu projeto, devemos mergea-lo.
Após realizar o merge, basta editar seu README.md e adicionar o trecho de código abaixo logo após o titulo
Com isso feito, o badge já deve aparecer na descrição do seu projeto!
Agora sempre que for necessário atualizar o valor da cobertura de testes basta executar a action e mergear o pull request que será criado.