Observação: O administrador do site deve habilitar Varredura de código para your GitHub Enterprise Server instance antes de usar este recurso. Se você desejar usar o GitHub Actions para fazer a varredura do seu código, o administrador do site também deverá habilitar o GitHub Actions e configurar a infraestrutura necessária. Para obter mais informações, consulte "Configurar o Varredura de código para seu aplicativo ".
Sobre sua configuração de Varredura de código
Você pode usar uma série de ferramentas para configurar Varredura de código no seu repositório. Para obter mais informações, consulte "Configuração do Varredura de código para um repositório".
A informação de registro e diagnóstico disponível para você depende do método que você usa para Varredura de código no repositório. Você pode verificar o tipo de Varredura de código que você está usando na aba Segurança do seu repositório, usando o menu suspenso Ferramenta na lista de alerta. Para obter mais informações, consulte "Gerenciar alertas de Varredura de código para o seu repositório".
Sobre análise e informações de diagnóstico
Você pode visualizar as análises e informações de diagnóstico para Varredura de código executar usando as análises de CodeQL em GitHub.
As informações de análise são exibidas para a análise mais recente em um cabeçalho, na parte superior da lista de alertas. Para obter mais informações, consulte "Gerenciar alertas de varredura de código para seu repositório. "
A informação de diagnóstico é exibida nos logs de fluxo de trabalho de ação e consiste em métricas resumidas e diagnósticos de extrator. Para obter informações sobre o acesso aos registros de Varredura de código em GitHub, consulte "Visualizar a saída do registro de Varredura de código" abaixo.
Se você estiver utilizando o CodeQL CLI fora de GitHub, você verá informações de diagnóstico na saída gerada durante a análise do banco de dados. Estas informações também estão incluídas nos resultados do SARIF que você enviou para GitHub com os resultados de Varredura de código.
Para obter informações sobre o CodeQL CLI, consulte "Configurar CodeQL CLI no seu sistema de CI".
Sobre métricas resumidas
As métricas resumidas incluem:
- Linhas de código na base de dados (usadas como linha de base), antes da criação e extração do banco de dados de CodeQL
- Linhas de código no banco de dados CodeQL extraído do código, incluindo bibliotecas externas e arquivos gerados automaticamente
- Linhas de código no banco de dados de CodeQL excluindo arquivos gerados automaticamente e bibliotecas externas
Sobre diagnósticos de extração de código-fonte de CodeQL
Os diagnósticos do extrator só cobrem os arquivos vistos durante a análise. As métricas incluem:
- Número de arquivos analisados com sucesso
- Número de arquivos que geraram erros do extrator durante a criação do banco de dados
- Número de arquivos que geraram avisos do extrator durante a criação do banco de dados
Visualizar a saída do registro de Varredura de código
Esta seção aplica-se à execução de Varredura de código usando GitHub Actions (CodeQL ou terceiros).
Depois de configurar o Varredura de código para o seu repositório, você poderá inspecionar a saída das ações conforme forem executadas.
-
Under your repository name, click Actions.
Você verá uma lista que inclui uma entrada para executar o fluxo de trabalho de Varredura de código. O texto da entrada é o título que você deu à sua mensagem de commit.
-
Clique na entrada para o fluxo de trabalho de Varredura de código.
-
Clique no nome do trabalho à esquerda. Por exemplo, Analise (LANGUAGE).
-
Revise a saída de log das ações deste fluxo de trabalho enquanto elas são executadas.
-
Depois que todos os trabalhos forem concluídos, você poderá visualizar os as informações dos alertas de Varredura de código que foram identificados. Para obter mais informações, consulte "Gerenciar alertas de Varredura de código para o seu repositório".
Observação: Se você criou um pull request para adicionar o fluxo de trabalho de Varredura de código ao repositório, os alertas desse pull request não serão exibidos diretamente na página de Varredura de código até que o pull request seja mesclado. Se algum alerta for encontrado, você poderá visualizá-los, antes do merge do pull request, clicando no link dos n alertas encontrados no banner na página de Varredura de código.
