Perguntas Frequentes
Respostas para as perguntas comuns sobre o uso do Axe Developer Hub
Conceitos
Qual é a diferença entre um projeto Git e um projeto Gitless?
O Developer Hub organiza seus resultados de forma diferente dependendo se seus testes usam Git:
- Um projeto Git associa os resultados de acessibilidade com branches e commits, permitindo que você acompanhe problemas até alterações específicas de código.
- Um projeto Gitless organiza os resultados como uma série de execuções de teste ordenadas por timestamp, sem quaisquer dados do Git.
- Dados do Git estão disponíveis ao usar o Axe Watcher, o Axe CLI ou o Axe DevTools para Web APIs (que carregam resultados via CLI). Projetos móveis são sempre Gitless.
Veja Entenda Seus Resultados e as entradas do glossário para Git e Gitless para mais detalhes.
O que é o limite de a11y e como posso configurá-lo?
O limite de a11y reflete a tolerância da sua organização para problemas de acessibilidade e determina o que conta como falha em seu pipeline CI/CD:
- Ele é calculado a partir de dois critérios: se todas as questões ou apenas novas questões devem ser contadas, e quais níveis de impacto incluir (Crítico é sempre incluído).
- Somente administradores do projeto podem configurar o limite.
Veja Alterar o Limite de A11y para detalhes completos.
O que significam os níveis de impacto (Crítico, Sério, Moderado, Menor)?
Cada violação de acessibilidade é atribuída a um de quatro níveis de impacto, do mais grave ao menos grave:
- Crítico: Usuários com deficiências são completamente impedidos de acessar ou interagir com uma funcionalidade.
- Sério: Usuários com deficiências enfrentam barreiras significativas ao interagir com o site.
- Moderado: Existem algumas barreiras, mas o conteúdo básico ainda é acessível.
- Menor: Problemas menos severos que ainda requerem resolução para conformidade total.
Veja o Glossário para definições detalhadas.
Comparações
O Developer Hub fornece dois tipos de comparações para projetos Git. Comparações entre branches aparecem na visualização Branches, onde cada branch é comparado com a execução mais recente do pipeline na branch padrão (isso mostra o que mudaria se você mesclasse agora mesmo). Comparações dentro do mesmo branch aparecem na visualização Commits, onde cada commit é comparado com o commit escaneado anterior no mesmo branch (isso informa o que um comprometimento específico introduziu ou corrigiu). Veja Entenda Seus Resultados para a visão completa.
Como posso determinar o que está mudando de uma versão para outra?
A visualização Branches em um projeto Git permite que você acompanhe as mudanças de acessibilidade entre versões usando uma comparação entre branches:
- O último commit escaneado de cada branch é comparado com a execução mais recente do pipeline em sua branch padrão.
- A comparação mostra o número total de problemas, novos problemas introduzidos, problemas resolvidos e quaisquer mudanças no número de estados de página verificados.
Para ver o que mudou em commits individuais dentro de uma branch, veja Como vejo o que mudou de commit para commit dentro de uma branch?
Como posso determinar qual será o impacto de um pull request?
Execute sua suíte de testes no branch do pull request para que os resultados apareçam no Axe Developer Hub:
- Na visualização Branches, cada branch não padrão exibe uma comparação entre branches com o branch padrão, mostrando novos problemas introduzidos, problemas resolvidos e a diferença total.
- Se você usar a Ação do GitHub, ela pode postar automaticamente um comentário no PR com um resumo e um link para os resultados completos.
Para detalhar o que cada commit na branch mudou, veja Como vejo o que mudou de commit para commit dentro de uma branch?
Como vejo o que mudou de commit para commit dentro de uma branch?
Na visualização Branches, clique em Ver Commits em qualquer branch para ver seus commits individuais verificados. Ao contrário das comparações entre branches na visualização Branches, a visualização Commits utiliza comparações dentro da mesma branch:
- Cada commit é comparado ao commit verificado anterior naquela branch, mostrando novos problemas, problemas resolvidos e mudanças nos estados de página.
- Apenas commits onde a suíte de testes foi executada aparecerão.
Para ver como a branch como um todo se compara ao branch padrão, veja Como comparo uma branch com a última execução de CI/CD no branch padrão?
Como comparo uma branch com a última execução de CI/CD no branch padrão?
A visualização Branches realiza automaticamente uma comparação entre branches para cada branch não padrão em relação à última execução do pipeline do branch padrão:
- Isso exige que um administrador de projeto tenha configurado o Axe Watcher para ser executado no branch padrão como uma execução de pipeline.
- A comparação mostra problemas totais, novos problemas, problemas resolvidos e diferenças nos estados de página.
Para ver o que mudou em commits individuais dentro dessa branch, veja Como vejo o que mudou de commit para commit dentro de uma branch?
Como obtenho resultados de comparação precisos antes de criar um pull request?
Para a comparação mais precisa entre branches antes de mesclar, mantenha sua branch de feature atualizada com o branch padrão:
- Mescle o branch padrão na sua branch de feature (por exemplo,
git merge main) antes de executar sua suíte de testes. - Envie o commit de mesclagem para que o Axe Developer Hub possa verificar a branch atualizada.
- A visualização Branches então comparará sua branch com a última execução do pipeline no branch padrão, mostrando apenas as mudanças de acessibilidade que sua branch realmente introduz.
Se sua branch de feature estiver atrás do branch padrão, a comparação pode apresentar problemas que já foram corrigidos no branch padrão, mas que ainda não foram mesclados na sua branch de feature. Mesclar o branch padrão primeiro elimina esses falsos positivos e reduz surpresas quando o pull request é mesclado.
CI/CD
Como posso garantir que nenhum novo problema de acessibilidade seja mesclado no meu código?
Integre o Axe Developer Hub ao seu pipeline de CI/CD para que verificações de acessibilidade sejam executadas automaticamente em cada commit ou pull request:
- Se você usar o GitHub, a Ação do Axe Developer Hub no GitHub pode bloquear PRs que introduzem erros de acessibilidade.
- Para outras plataformas como GitLab ou Bitbucket, use a API de Serviço REST para consultar resultados e falhar seu pipeline quando problemas forem detectados.
- Você pode ajustar o que é considerado uma falha configurando o limite de a11y.
Como integro o Axe Developer Hub ao meu pipeline de CI/CD se eu não usar GitHub?
Você pode usar a API de Serviço REST para integrar com qualquer plataforma de CI/CD:
- A API de Serviço REST permite que você consulte o Axe Developer Hub por resultados após a execução da sua suíte de testes.
- A API retorna a contagem de problemas, novas violações, violações resolvidas e um link para os resultados completos no Developer Hub.
- Você pode usar esta resposta para aprovar ou reprovar seu pipeline no GitLab, Bitbucket, Jenkins ou qualquer outra plataforma.
Gestão de Projetos
Como posso ver as verificações de acessibilidade de outros membros da equipe em um projeto?
Todos os membros do projeto podem ver todos os resultados dentro de um projeto compartilhado assim que forem adicionados:
- Adicione os membros da equipe através da página de configurações de Membros.
- Nos projetos Git, a visualização de Branches exibe resultados agrupados por chave de API, para que você possa ver quem executou cada verificação.
Para detalhes sobre funções e permissões, veja Configurar Projetos para Uso da Equipe.
Como exporto meus resultados de acessibilidade?
O Centro de Desenvolvedores oferece várias maneiras de exportar seus dados:
- A partir da visualização do resumo de problemas, clique no botão Exportar Problemas para baixar os resultados como CSV ou JSON.
- Para acesso programático, use o API de Serviço REST para consultar os resultados de um commit e projeto específicos.
Veja Obtenha Resultados Programaticamente para mais opções.
