Observação
O administrador do site deve habilitar code scanning antes que você possa usar esse recurso. Para saber mais, confira Configurando a verificação de código para seu dispositivo.
Talvez você não consiga habilitar ou desabilitar code scanning se um proprietário da empresa tiver definido uma GitHub Code Security política no nível da empresa. Para saber mais, confira Como impor políticas para segurança e análise de código na empresa.
O que é o página de status da ferramenta?
O página de status da ferramenta mostra informações sobre todas as suas ferramentas code scanning e é um bom ponto de partida para depurar problemas quando code scanning não estiver funcionando como esperado.
Observação
O página de status da ferramenta mostra o status da ferramenta no nível do repositório apenas para o branch padrão, e não no nível da organização.
Indicadores de status da ferramenta
O página de status da ferramenta exibe um dos três status:
- Todas as configurações estão funcionando: todas as ferramentas estão operando conforme o esperado
- Algumas configurações precisam de atenção: algumas ferramentas têm avisos ou problemas não críticos
- Algumas configurações não estão funcionando: uma ou mais ferramentas têm erros críticos
Quais informações estão disponíveis
Para todas as code scanning ferramentas
- Status e saúde da configuração
- Agendamento de verificação
- Tempos de verificação primeiro e mais recentes
- Regras usadas em verificações
Para ferramentas integradas como CodeQL
Além das informações listadas acima, o página de status da ferramenta para ferramentas integradas fornece os seguintes detalhes:
- Percentuais de cobertura de arquivo por linguagem de programação
- Detalhes de configuração para cada tipo de configuração
- Mensagens de erro específicas
- Relatórios CSV para download de arquivos analisados
- Listas de regras usadas e contagens de alertas para download
Como CodeQL define arquivos escaneados
CodeQL indica um arquivo como analisado se algumas linhas de código desse arquivo foram processadas.
Idiomas interpretados
- Configuração padrão: os arquivos analisados incluem todos os arquivos de código-fonte para idiomas CodeQL que pode analisar
- Configuração avançada: você pode usar
pathsepaths-ignoredefinir quais arquivos examinar. Confira Verificação de código com CodeQL.
Idiomas compilados
O página de status da ferramenta informa os arquivos presentes antes da execução das etapas de compilação manual ou de autobuild. Os arquivos gerados durante o processo de build não são mostrados. Confira Verificação de código do CodeQL para linguagens compiladas.
Cálculo de cobertura
Os percentuais de cobertura de arquivo respeitam os arquivos excluídos pelas propriedades de configuração paths e paths-ignore.
Noções básicas sobre percentuais de cobertura de arquivo
Use os percentuais de cobertura de arquivo para depurar e melhorar sua análise:
- Porcentagem alta: Code scanning está funcionando conforme o esperado para esse idioma
- Porcentagem baixa: investigue a saída de diagnóstico. Confira O CodeQL verificou menos linhas do que o esperado
- Porcentagem zero: você pode ter código em idiomas que não estão sendo analisados no momento. Atualize sua configuração para incluir esses idiomas. Confira Opções de configuração de fluxo de trabalho para verificação de código
Observação
Se você configurar a configuração avançada e a configuração padrão, o página de status da ferramenta mostrará apenas a configuração padrão.
Recursos de solução de problemas
O página de status da ferramenta ajuda a solucionar problemas por meio de:
- Mensagens de erro: explica por que as ferramentas não estão sendo executadas conforme o esperado com ações sugeridas
- Dados de cobertura de arquivo: mostra quais arquivos e idiomas estão sendo analisados
- Detalhes da configuração: exibe informações sobre cada execução de análise
- Relatórios baixáveis: fornece relatórios CSV com informações detalhadas de arquivo e regra