Melhorar gatilhos para workflows dependentes dos deploys de preview

[thlmenezes]

Sua solicitação de recurso está relacionada a um problema? Por favor, descreva.

Depender de sleeps e healthchecks para a boa execução do fluxo de validação automático adiciona um grau de incerteza não ideal para o contexto de CI/CD. Vejamos o exemplo abaixo:

- run: sleep 180
- name: Waiting for 200 from the Vercel Preview
  uses: patrickedqvist/[email protected]
  id: vercelPreview
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    max_timeout: 120

Caso dentro desse período não haja um novo deploy de preview, a validação não será executada.

Descreva a solução desejada

Temos os seguintes objetivos:

1. Cancelar graciosamente ou não executar fluxos de trabalho, caso não haja novo deploy
2. Alterar gatilhos dos fluxos de trabalho, mantendo feedbacks automatizados no PR
   2.1 lighthouse.yml
   2.2 e2e.yml

Baseado nesse artigo, uma implementação possível é:

Ambos fluxos de trabalho

• Modificar evento para deployment_status
• Filtrar execução usando:

if: github.event.deployment_status.environment == 'Preview' && github.event.deployment_status.state == 'success'

• Poderia remover a verificação de preview nas validações do lighthouse.yml
• Utilizar url vindo de ${{ github.event.deployment_status.target_url }}

lighthouse.yml

Além dos ajustes anteriores, para manter os comentários de revisão

• Busca id do PR ao commit/gatilho, usando https://github.com/jwalton/gh-find-current-pr
• Monta URL para postar comentários de review no PR, leia mais em comentários das revisões de pull request
  
• Atualiza argumento commentUrl no fluxo de trabalho foo-software/[email protected]

Descreva as alternativas que você considerou

Pesquisei outros fluxos de trabalho disponíveis no github marketplace, mas não encontrei nenhuma que considerava os casos de PRs que não alteram código que ativa a geração de uma nova versão do site. Todas as alternativas com manutenção suficiente para serem consideradas eram baseadas na mesma abordagem de sleeps e healthchecks.