O Cypress Dashboard consegue integrar seus testes Cypress com seu Workflow do GitHub através de verificações de status e comentários de pull requests.
Um projeto primeiramente precisa estar configurado para gravação para que o Cypress Dashboard possa utilizar a integração com o GitHub.
A plataforma local GitHub Enterprise atualmente não é suportada.
A Integração com o GitHub depende que o seu ambiente de integração contínua forneça dados SHA de commit (tipicamente via variável de ambiente). Isso não é um problema para a maioria dos usuários, mas se você estiver com problemas de integração com o GitHub com sua configuração de integração contínua, por favor, certifique-se que a informação git está sendo enviada corretamente seguindo essas diretrizes. Se após isso você ainda estiver enfrentando problemas, por favor, entre em contato conosco.
Antes que você possa habilitar a integração com o GitHub em seus projetos Cypress, você primeiro deve instalar o app Cypress GitHub. Você pode iniciar o processo de instalação do aplicativo através da página de configuração da sua organização, ou a partir de uma página de configuração de um projeto no Cypress Dashboard.
- Vá para a Página de organizações no dashboard, ou abra a lista de organizações.
- Selecione a organização que você deseja integrar com uma conta do GitHub ou organização do GitHub.
- Visite a página de integrações da organização selecionada, na navegação lateral.
- CLique no botão Instalar Integração com o GitHub.
- Selecione sua organização na lista de organizações.
- Selecione o projeto que você deseja integrar com um repositório GitHub. Docs Cypress
- Vá para a página de configurações do projeto. Docs Cypress
- Role até a seção Integração com o GitHub.
- Clique no botão Instalar Cypress GitHub App.
Assim que você iniciar o processo de instalação do app do GitHub por meio de uma página de configurações Cypress da organização, ou uma página de configurações do projeto, você será redirecionado(a) ao GitHub.com para completar a instalação:
- Selecione a conta ou organização GitHub que você deseja integrar com seu Cypress Dashboard da organização.
- Escolha associar todos os repositórios ou apenas selecione repositórios GitHub
com a instalação do seu app Cypress GitHub.
Todos os atuais e futuros repositórios serão inclusos com esta instalação, caso selecionar Todos os repositórios.
- Clique no botão instalar para completar a instalação.
Após concluir a instalação do app Cypress Github para a sua organização, você agora pode habilitar a Integração com o Github para qualquer projeto Cypress.
- Vá para a página de configurações do projeto.
- role até a seção integração com o GitHub.
Você pode rapidamente acessar as configurações de Integração do GitHub de um projeto, clicando no link configurar
do projeto desejado na página de Integrações de uma organização:
- Selecione um repositório GitHub a ser associado com o projeto.
Assim que um repositório GitHub for associado a um projeto Cypress, a integração com o GitHub será habilitada imediatamente:
Você também pode ver todas as Integrações com o Github habilitadas em projetos Cypress na sua página de integrações das suas organizações:
Se as verificações de status estão habilitadas nas configurações de integração com o Github de um projeto, O Cypress Dashboard irá reportar o status de teste Cypress ao GitHub para commits relacionados.
Verificações de status ajudam a previnir a fusão de um commit ou pull-request no resto da sua base de código até que todos os seus testes Cypress tenham passado.
O app Cypress GitHub reporta as verificações de status de commit em dois estilos separados:
- Uma verificação por grupo de execução.
- Ou uma por arquivo spec.
Cada verificação de status irá reportar o número de falhas ou aprovações no teste, e o link de detalhes associados irá lhe direcionar à página de execução de testes no Cypress Dashboard para lhe ajudar a ir mais fundo no problema via mensagens de erro, stack traces, screenshots, e gravações de vídeo:
As verificações de status do GitHub são opcionais, e podem ser desabilitadas nas configurações de Integração com o Github:
O app Cypress Github pode fornecer informações de teste detalhadas nos pull-requests por meio de comentários, que incluem:
- Estatísticas de execução, tais como: testes aprovados, reprovados, pulados e acima do limite.
- Detalhes do contexto de execução:
- O projeto Cypress associado
- Status final de execução (aprovado, reprovado, etc)
- Commit SHA vinculado ao GitHub commit
- A hora em que a execução começou e terminou, bem como a duração.
- Sistema operacional e versão do navegador.
- Falhas de execução:
- As 10 primeiras falhas são exibidas com um link para ver mais.
- Cada teste reprovado é vinculado à falha associada no painel Cypress.
- Miniaturas de capturas de tela também são fornecidas com cada falha para fornecer contexto de forma conveniente.
Um exemplo de um comentário de pull-request Cypress pode ser visto abaixo:
Comentários de pull-requests e miniaturas de capturas de telas em falhas são opcionais, e podem ser desabilitados se não forem necessários nas configurações de Integração com o GitHub de um projeto:
Você pode desinstalar o app Cypress GitHub ao seguir os seguintes passos:
- Acesse as *configurações da sua organização no GitHub.
- Clique nos apps instalados no GitHub.
- Clique em configurar ao lado do aplicativo Cypress.
- CLique em desinstalar abaixo da seção "desinstalar Cypress".