Observação
O administrador do site precisa habilitar a code scanning antes que você possa usar esse recurso. Para saber mais, confira Como configurar a verificação de código do seu dispositivo.
Talvez você não consiga habilitar ou desabilitar o code scanning se um proprietário da empresa tiver definido uma política de GitHub Advanced Security 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 página de status da ferramenta mostra informações sobre todas as ferramentas de verificação de código e é um bom ponto de partida para problemas de depuração. Para obter mais informações sobre o que é a ferramenta e as informações fornecidas, consulte Sobre a página de status da ferramenta.
Como exibir a página de status da ferramenta para um repositório
A página de alertas da verificação de código de code scanning de cada repositório inclui uma faixa de ferramentas com um resumo da integridade da análise de verificação de código e o acesso à página de status da ferramenta para explorar sua configuração.
-
Em GitHub, acesse a página principal do repositório.
-
Abaixo do nome do repositório, clique em Security. Caso não consiga ver a guia "Security", selecione o menu suspenso e clique em Security.
-
Na barra lateral esquerda, clique em Code scanning.
-
Clique em Status da ferramenta na faixa de ferramentas.
Como usar a página de status da ferramenta
Na página de status da ferramenta, você verá um resumo de uma ferramenta, realçada na barra lateral. Use a barra lateral para ver resumos de diferentes ferramentas.
Para ferramentas integradas, como o CodeQL, você pode ver um total percentual de todos os arquivos verificados mais recentemente no seu repositório, organizados pela linguagem de programação. Baixe também os relatórios de linguagem detalhados no formato CSV. Veja os detalhes de download dos arquivos analisados.
Como acessar informações detalhadas sobre as ferramentas
Quando quiser ver informações mais detalhadas para a ferramenta exibida no momento, selecione uma configuração específica em "Tipos de instalação".
Em "Configurações" à esquerda da tela, veja informações de cada análise executada por esse tipo de configuração e todas as mensagens de erro relevantes. Para ver informações detalhadas sobre a execução de análise mais recente, selecione uma configuração na barra lateral. Baixe os detalhes de exatamente quais regras foram executadas nessa verificação do código e quantos alertas foram encontrados por regra. Para obter mais informações, confira Como baixar listas das regras usadas.
Essa exibição também mostrará as mensagens de erro. Para obter mais informações, confira Depuração com a página de status da ferramenta.
Como baixar os detalhes dos arquivos analisados
Para ferramentas integradas, como o CodeQL, baixe relatórios detalhados da página de status da ferramenta no formato CSV. Isso mostrará:
- Qual configuração foi usada para verificar cada arquivo
- O caminho do arquivo
- A linguagem de programação do arquivo
- Se o arquivo foi extraído com êxito
Para baixar um relatório, selecione uma ferramenta de seu interesse. Em seguida, no canto superior direito da página, clique no botão .
Como baixar listas das regras usadas
Baixe a lista de regras de referência usada pela code scanning no formato CSV. Isso mostrará:
- A configuração usada
- A origem da regra
- O identificador SARIF
- Quantos alertas foram encontrados
Para baixar um relatório, selecione uma configuração de seu interesse. Em seguida, clique em no canto superior direito da página e selecione Download list of rules used.
Removendo configurações
Você pode remover configurações obsoletas, duplicadas ou indesejadas para o branch padrão do repositório.
Para remover uma configuração, selecione a configuração que você deseja excluir. Em seguida, clique em no canto superior direito da página e selecione Delete configuration. Depois de ler o aviso sobre alertas, para confirmar a exclusão, clique no botão Excluir.
Observação
Você só pode usar a página de status da ferramenta para remover as configurações do branch padrão de um repositório. Para obter informações sobre como remover configurações de branches não padrão, confira Resolver alertas de varredura de código.
Depuração usando a página de status da ferramenta
Se você observar que há um problema com a análise na página de alertas da code scanning, use a página de status da ferramenta para identificar o problema. Para ferramentas integradas, você poderá ver mensagens de erro específicas na seção de informações detalhadas, relacionadas a ferramentas específicas da code scanning. Essas mensagens de erro contêm informações sobre o motivo pelo qual a ferramenta pode não ser executada conforme o esperado e as ações que podem ser executadas. Para obter mais informações sobre como acessar esta seção da página de status da ferramenta, confira Como acessar informações detalhadas sobre as ferramentas.
Para ferramentas integradas, como CodeQL, você também pode usar informações de cobertura de arquivo para aprimorar sua análise. Para obter mais informações sobre como interpretar os percentuais de cobertura de arquivo, consulte Sobre a página de status da ferramenta.
Para saber mais, confira Solução de erros de análise de escaneamento de código e Solução de problemas de uploads SARIF.