Esta versão do GitHub Enterprise Server será descontinuada em 2026-03-17. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Sobre a página de status da ferramenta

O página de status da ferramenta fornece visibilidade sobre a integridade e o desempenho das ferramentas code scanning no seu repositório.

Quem pode usar esse recurso?

Usuários com com acesso para gravação

O Code scanning está disponível para os seguintes tipos de repositório:

  • Repositórios públicos no GitHub.com
  • Repositórios de propriedade da organização em GitHub Team, GitHub Enterprise Cloudou GitHub Enterprise Server, com GitHub Advanced Security habilitados.

Neste artigo

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 que é página de status da ferramenta?

O página de status da ferramenta mostra informações sobre todas as ferramentas code scanning e é um bom ponto de partida para debugar problemas quando code scanning não está funcionando conforme o esperado.

Observação

A página página de status da ferramenta exibe o status da ferramenta no nível do repositório apenas para o ramo padrão, 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 ferramentas code scanning

  • 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 o CodeQL define os arquivos verificados

CodeQL reporta um arquivo como verificado se algumas linhas de código desse arquivo foram processadas.

Idiomas interpretados

  •           **Configuração padrão**: os arquivos verificados incluem todos os arquivos de código-fonte para as linguagens CodeQL que pode analisar

  •         **Configuração avançada**: você pode usar `paths` e `paths-ignore` definir quais arquivos examinar. Confira [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql).

Idiomas compilados

O página de status da ferramenta relata arquivos presentes antes de executar etapas de compilação automática ou manual. 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 essa linguagem

  •           **Porcentagem baixa**: investigue a saída de diagnóstico. Confira [AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected)

  •         **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 [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed)

Observação

Se você configurar tanto a configuração avançada quanto a configuração padrão, a 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 você 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

Leitura adicional

  •         [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)