Cartoon gears and neon rolling marbles rolling through a track

Gerencie e monitore fluxos de trabalho no GitHub Actions

Bekah Whittle
Bekah Whittle // Director, Field Services // GitHub

Esteja você mergulhando em fluxos de trabalho individuais, buscando um ponto de vista administrativo com saídas de metadados ou organizando arquivos de fluxo de trabalho, GitHub Actions fornece as ferramentas que você precisa. Neste guia, orientaremos você sobre fundamentos do gerenciamento e monitoramento de fluxos de trabalho, usando insights do mundo real para garantir que você aproveite todo o potencial da plataforma. A Coyote Logistics se juntará a nós ao longo do caminho para adicionar informações especializadas sobre o gerenciamento de arquivos de fluxo de trabalho.


Neste guia, você aprenderá:

  • Como repetir os fluxos de trabalho, diretamente da guia Actions, para a solução rápida de problemas

  • Técnicas para se aprofundar nos arquivos YAML, a fim de entender e modificar as especificações de cada fluxo de trabalho

  • Formas de analisar as métricas de uso dos trabalhos para a otimização de recursos e decisões orçamentárias


Analisando os fluxos de trabalhos na guia Actions

A guia Actions de um repositório fornece um instantâneo de todos os fluxos de trabalho desse repositório. Essa visão centralizada é essencial para verificações rápidas no status dos fluxos de trabalho. À medida que o número de fluxos de trabalho aumenta, alguns deles poderão ser ocultados para manter a interface mais organizada. Mas lembre-se de que a guia Actions é somente um ponto inicial.

Repetindo fluxos de trabalho 

Os fluxos de trabalho poderão falhar ocasionalmente, devido a imprevistos como testes não conclusivos (testes de software que produzem resultados tanto positivos como negativos, mesmo na ausência de alterações no código ou de parâmetros de testes). Ao invés de tentar resolver o problema imediatamente, uma solução rápida é a repetição do fluxo de trabalho. A guia Actions oferece uma opção de repetição fácil, ajudando a resolver pequenos contratempos rapidamente. Para isso, selecione Re-run all jobs, após selecionar o fluxo de trabalho na guia Actions. 

Visualizando o uso de trabalhos

Um gerenciamento eficiente dos fluxos de trabalho vai além da aprovação ou reprovação de um trabalho. Isso envolve um entendimento dos recursos consumidos. Com o Actions, você visualiza facilmente métricas como o tempo gasto e o custo associado com cada trabalho. Esses dados ajudam na otimização e nas decisões orçamentárias. Após selecionar um fluxo de trabalho na guia Actions, você verá uma guia Usage do lado direito, onde poderá encontrar essas informações. 

Analisando os detalhes do fluxo de trabalho na seção de códigos <>

Apesar de a guia Actions proporcionar uma ótima visão geral, a alma dos fluxos de trabalhos é o código do repositório. Para ter um conhecimento abrangente de cada fluxo de trabalho, é essencial se aprofundar no código.

Localizando fluxos de trabalho

Todos os fluxos de trabalho residem na pasta .github do repositório. Dentro dela, você encontrará outra pasta .github/workflows. Cada fluxo de trabalho é representado aqui como um arquivo YAML.

Revisando fluxos de trabalho 

Ao navegar nesses arquivos YAML, você verá as especificações de cada fluxo de trabalho: os acionadores, as ações tomadas e a sequência delas. Isso é bastante útil para solucionar problemas ou para quando você estiver considerando fazer modificações.

Integrando com scripts 

Os fluxos de trabalho podem, com frequência, estar associados a certos scripts para automatizar tarefas específicas. Esses scripts podem ser encontrados integrados no mesmo diretório .github . Por exemplo, um script poderá administrar a implantação com base nas alterações de rótulos.

Priorizamos clareza funcional em vez de convenções rígidas de nomenclatura ao estruturar e gerenciar arquivos de fluxo de trabalho. Os arquivos de fluxo de trabalho são fáceis de descobrir, pois eles residem principalmente no diretório de “fluxos de trabalho” designado. Mas, mais importante, eles devem ser facilmente identificados. Testamos diferentes fluxos de trabalho de armazenamento em um repositório privado do GitHub Actions, que permite um versionamento mais flexível, mas também pode resultar em redundância.

Chris Taylor
Chris Taylor // Enterprise Architect // Coyote Logistics

Detalhes do markdown em arquivos do fluxo de trabalho

O GitHub Actions não só permite que você monitore o status dos trabalhos, mas também oferece uma camada mais profunda de insights por meio de saídas do markdown nos arquivos do fluxo de trabalho. Esses detalhes do markdown apresentam uma variedade de informações, desde os resultados dos trabalhos até metadados complexos.

Usando o Marketplace Actions

Ao incorporar o Actions do GitHub Marketplace, muitos são acompanhados por saídas do markdown incorporadas. Essas saídas oferecem um contexto importante, além de métricas de desempenho e até mesmo informações diagnósticas. Assim, vale a pena explorar as seções de markdown para os Actions que você adotar no Marketplace.

Criando scripts para seu próprio markdown

Para quem procura uma abordagem personalizada, o Actions permite também criar scripts para suas próprias saídas do markdown. Ao personalizar essas seções, você pode incluir métricas ou logs específicos que forem cruciais para o seu projeto. Essa glanularidade é inestimável e fornece uma visão abrangente dos eventos do fluxo de trabalho, além de garantir melhor eficiência e clareza.

A adição da saída do markdown aos fluxos de trabalho é simples:

steps:
  - name: Adding markdown
    run: echo '### Hello world! 🚀' >> $GITHUB_STEP_SUMMARY

Screenshot of the GitHub job summary showing the markdown-added "Hello world!"

Instantâneo do resumo de trabalhos do GitHub mostrando "Hello world!" com markdown adicionado

Para obter mais informações, confira a documentação completa para adicionar comandos do fluxo de trabalho.

Próximo: Estratégias avançadas de automação de testes com o GitHub Actions

Buscando elevar o nível dos seus testes? Não perca nosso próximo guia sobre testes avançados com o GitHub Actions. Saiba como escalar suas iniciativas de teste de forma eficiente e tire o máximo proveito do GitHub Marketplace.