Exercício – Adicionar uma notificação de build

  • 7 minutos

É importante que os membros da equipe saibam o status de build. Uma maneira fácil de determinar rapidamente o status do build é adicionar uma notificação de build ao arquivo README.md no GitHub. Vejamos com a equipe como isso é feito.

Paulo está em sua mesa vendo emails. Ele está respondendo ao terceiro email relacionado ao status do build do site do Space Game.

Paulo: Deve haver uma maneira de automatizar uma mensagem de status. Nós temos o pipeline, portanto, deveríamos ser capazes de colocar um status em algum lugar. Talvez Clara saiba como podemos fazer isso.

Paulo encontra Clara conversando com Marina na sala de descanso.

Paulo: Olá, Marina. Posso conversar com Clara um minuto?

Marina: Eu precisava mesmo ir a uma reunião. Fique à vontade.

Clara: Olá, Paulo. O que está acontecendo?

Paulo: Eu gosto muito das alterações que fizemos no pipeline de build usando o Azure Pipelines. Além disso, o Git é um sistema de controle de versão excelente. Eu queria saber: existe uma maneira de informar as pessoas sobre o status do build?

Clara: Há sim. Podemos usar uma notificação de build.

O que é uma notificação de build?

Uma notificação faz parte do Microsoft Azure Pipelines. Ela tem métodos que você pode usar para adicionar uma imagem SVG que mostra o status do build em seu repositório do GitHub.

A maioria dos repositórios do GitHub inclui um arquivo chamado README.md, que é um arquivo Markdown que inclui os detalhes e a documentação essenciais de seu projeto. O GitHub renderiza esse arquivo na home page do projeto.

Veja um exemplo de notificação de build:

Captura de tela do GitHub que mostra a notificação de build. O status mostra que o build mais recente foi bem-sucedido.

Neste exercício, você tornará sua notificação de build visível para todos. Isso pode não ser uma boa ideia para seus projetos privados, pois as informações do build serão disponibilizadas ao público.

Para verificar se a notificação de build está visível:

  1. No Azure DevOps, navegue até sua organização.

  2. Selecione Configurações da organização no canto interior.

  3. Em Pipelines, selecione Configurações.

  4. Desative Desabilitar o acesso anônimo a notificações.

    Captura de tela do Azure DevOps que mostra como desabilitar o acesso anônimo às notificações.

Você precisa fazer uma alteração semelhante em seu projeto:

  1. Acesse o projeto.
  2. Procure Configurações do projeto no canto inferior.
  3. Em Pipelines, selecione Configurações.
  4. Desative Desabilitar o acesso anônimo a notificações.

Adicionar a notificação de build

Até agora, você criou branches do Git localmente para fazer alterações no projeto do Space Game. Você também pode sugerir alterações diretamente por meio do GitHub. Nesta seção, você faz isso para configurar sua notificação de status.

  1. No Azure DevOps, no painel esquerdo, selecione Pipelines e, sem seuida, seu pipeline.

  2. Selecione as reticências (...) no canto superior direito e escolha Notificação de status.

    Captura de tela do Azure Pipelines que mostra o menu de opções usado para definir a notificação de build.

  3. Em Exemplo de Markdown, selecione o botão Copiar para copiar o código Markdown para a área de transferência.

  4. No GitHub, vá para seu projeto.

  5. Verifique se você está no branch main. Na área de arquivos, abra o arquivo README.md.

  6. Selecione Editar este arquivo (o ícone de lápis) para abrir o arquivo no editor.

  7. Na parte superior da página, adicione uma linha em branco e cole o conteúdo da área de transferência.

  8. Selecione a guia Visualização para ver as alterações propostas.

    O GitHub renderiza o arquivo markdown e mostra a notificação de build.

    Captura de tela do GitHub que mostra uma visualização da notificação de build.

Fazer commit das alterações na ramificação principal

Nesta seção, você confirmará suas alterações no branch main no GitHub.

  1. Selecione Confirmar alterações.

  2. Na área Confirmar mensagem, especifique uma mensagem de confirmação, como "Adicionar notificação de build".

    Captura de tela do GitHub que mostra a mensagem de commit.

  3. Mantenha a opção Confirmar diretamente para o main branch selecionada e, em seguida, escolha Confirmar as alterações para confirmar as alterações no branch main.

    Sua notificação é exibida na página README.md.

    Captura de tela da notificação de build final, como ela aparece na página README.

    Esse processo é uma forma mais básica de mesclar código no GitHub. Em vez de confirmar diretamente, você poderia ter criado uma solicitação de pull com as alterações para outras pessoas examinarem.

    Na prática, você mudaria para o branch main e efetuaria pull das alterações mais recentes do GitHub na próxima vez em que precisasse adicionar um recurso ou solucionar um bug.

Paulo: Clara, você fez uma alteração diretamente em main. Por que você não usou o fluxo que me ensinou? Você sabe, com os branches de recursos.

Clara: Poderíamos ter feito isso. Mas, às vezes, quando as pessoas estão alterando apenas o arquivo LEIAME ou outros arquivos de documentação, elas confirmam diretamente em main. Além disso, você e eu conseguimos verificar o trabalho juntos antes de mesclar a alteração.

Mas isso traz um bom ponto. Se todos nós apenas confirmássemos no main quando quiséssemos, poderíamos inserir problemas de código em nosso branch main.

Paulo: Queria falar com você sobre isso.

Paulo e Clara continuam a conversa enquanto voltam para seus escritórios.