Setting up code scanning for a repository

Options for setting up Varredura de código

You decide how to generate Varredura de código alerts, and which tools to use, at a repository level. O GitHub fornece suporte totalmente integrado para a análise do CodeQL e também é compatível com ferramentas de análise usando ferramentas de terceiros. Para obter mais informações, consulte "Sobre CodeQL".

Setting up Varredura de código using actions

Usar ações para executar Varredura de código levará minutos. Para obter mais informações, consulte "Sobre a cobrança do GitHub Actions."

1. No GitHub, navegue até a página principal do repositório.

2. No seu nome de repositório, clique em Segurança.

   

3. À direita de "Varredura de código", clique em Configurar Varredura de código. If Varredura de código is missing, you need to ask an organization owner or repository administrator to enable Segurança Avançada GitHub. For more information, see "Managing security and analysis settings for your organization" or "Managing security and analysis settings for your repository."

   

4. Em "Começar com Varredura de código", clique em Configurar este fluxo de trabalho no Fluxo de trabalho de análise do CodeQL ou em um fluxo de trabalho de terceiros.

   

5. Para personalizar como Varredura de código faz a varredura do seu código, edite o fluxo de trabalho.

   Geralmente, você pode fazer commit do Fluxo de trabalho de análise do CodeQL sem fazer nenhuma alteração nele. No entanto, muitos dos fluxos de trabalho de terceiros exigem uma configuração adicional. Portanto, leia os comentários no fluxo de trabalho antes de fazer o commit.

   Para obter mais informações, consulte "Configurando Varredura de código."

6. Use o menu suspenso Iniciar commit e digite uma mensagem de commit.

   

7. Escolha se você gostaria de fazer commit diretamente no branch-padrão ou criar um novo branch e iniciar um pull request.

   

8. Clique em Fazer commit do novo arquivo ou Propor novo arquivo.

No Fluxo de trabalho de análise do CodeQL padrão, Varredura de código está configurado para analisar o seu código cada vez que você fizer push de uma alteração no branch-padrão ou em qualquer branch protegido, ou criar um pull request contra o branch padrão. Como resultado, Varredura de código vai começar agora.

Bulk set up of Varredura de código

You can set up Varredura de código in many repositories at once using a script. Para obter um exemplo de um script que apresenta pull requests para adicionar um fluxo de trabalho de GitHub Actions em vários repositórios, veja o repositório jhutchings1/Create-ActionsPRs.

Visualizar a saída do registro de Varredura de código

After setting up Varredura de código for your repository, you can watch the output of the actions as they run.

1. No nome do seu repositório, clique em Ações.

   

   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.

   

2. Clique na entrada para o fluxo de trabalho de Varredura de código.

3. Clique no nome do trabalho à esquerda. Por exemplo, Analise (LANGUAGE).

   

4. Revise a saída de log das ações deste fluxo de trabalho enquanto elas são executadas.

5. 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".

Entendendo as verificações de pull request

Each Varredura de código workflow you set to run on pull requests always has at least two entries listed in the checks section of a pull request. Há uma entrada para cada um dos trabalhos de análise no fluxo de trabalho e uma entrada final para os resultados da análise.

Os nomes das verificações de análise de Varredura de código assumem a forma: "TOOL NAME / JOB NAME (TRIGGER)." Por exemplo, para CodeQL, a análise do código C++ tem a entrada "CodeQL / Analyze (cpp) (pull_request)." Você pode clicar em Detalhes em uma entrada de análise de Varredura de código para ver os dados de registro. Isso permite que você corrija um problema caso ocorra uma falha no trabalho de análise. Por exemplo, para a análise de Varredura de código de linguagens compiladas, isto pode acontecer se a ação não puder criar o código.

Quando os trabalhos de Varredura de código forem concluídos, GitHub calcula se quaisquer alertas foram adicionados pelo pull request e adiciona a entrada "Varredura de código results / TOOL NAME" à lista de verificações. Depois de Varredura de código ser executado pelo menos uma vez, você poderá clicar em Detalhes para visualizar os resultados da análise. Se você usou um pull request para adicionar Varredura de código ao repositório, você verá inicialmente uma mensagem de "Análise ausente" ao clicar em Detalhes na verificação de resultados de "Varredura de código / NOME DA FERRAMENTA".

Motivos da mensagem "faltando ausente"

Depois que Varredura de código analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que Varredura de código calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar Varredura de código a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. Neste caso, ao clicar na verificação de resultados no pull request você verá a mensagem "Análise ausente para o commit de base SHA-HASH".

Há outras situações em que não pode haver análise para o último commit do branch de base para um pull request. Isso inclui:

• O pull request foi levantado contra um branch diferente do branch padrão, e este branch não foi analisado.

  Para verificar se um branch foi verificado, acesse a página Varredura de código, clique no menu suspenso Branch e selecione o branch relevante.

  

  A solução nesta situação é adicionar o nome do branch de base para a especificação on:push e on:pull_request no fluxo de trabalho de Varredura de código nesse branch e, em seguida, fazer uma alteração que atualize o pull request aberto que você deseja escanear.

• O último commit no branch de base para o pull request está atualmente sendo analisado e a análise ainda não está disponível.

  Aguarde alguns minutos e depois faça push de uma alteração no pull request para acionar o recurso de Varredura de código.

• Ocorreu um erro ao analisar o último commit no branch base e a análise para esse commit não está disponível.

  Faça merge uma mudança trivial no branch de base para acionar Varredura de código neste commit mais recente e, em seguida, faça push de uma alteração para o pull request reiniciar Varredura de código.

Próximas etapas

After setting up Varredura de código, and allowing its actions to complete, you can:

• Visualizar todos os alertas de Varredura de código gerados para este repositório. Para obter mais informações, consulte "Gerenciar alertas de Varredura de código para o seu repositório".
• View any alerts generated for a pull request submitted after you set up Varredura de código. Para obter mais informações, consulte "Triar alertas de Varredura de código em pull requests".
• Configurar notificações para execuções concluídas. Para obter mais informações, consulte “Configurando notificações".
• Investigue todos os problemas que ocorrerem com a configuração inicial de CodeQL Varredura de código. Para obter mais informações, consulte "Solucionar problemas no fluxo de trabalho de CodeQL".
• Personalize como Varredura de código faz a varredura de código no seu repositório. Para obter mais informações, consulte "Configurando Varredura de código."