Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Alertas de varredura de código de triagem em pull requests

Quando code scanning identifica um problema em um pull request, você poderá revisar o código destacado e resolver o alerta.

Who can use this feature

If you have read permission for a repository, you can see annotations on pull requests. With write permission, you can see detailed information and resolve code scanning alerts for that repository.

A Code scanning está disponível para os repositórios pertencentes à organização no GitHub Enterprise Server. Esse recurso exige uma licença do GitHub Advanced Security. Para obter mais informações, confira "Sobre o GitHub Advanced Security".

Sobre os resultados de code scanning em pull requests

Em repositórios onde code scanning está configurado como uma verificação de pull request, code scanning verifica o código no pull request. Por padrão, isso é limitado a pull requests que visam o branch-padrão ou branches protegidos, mas você pode alterar esta configuração em GitHub Actions ou em um sistema de CI/CD de terceiros. Se a mesclagem das alterações for gerar novos alertas de code scanning no branch de destino, os alertas serão relatados em vários locais.

  • Verificar os resultados na solicitação de pull
  • A guia Conversa da solicitação de pull, que faz parte de uma revisão de solicitação de pull
  • A guia Arquivos alterados da solicitação de pull

Se você tiver permissão de gravação no repositório, poderá ver todos os alertas existentes da code scanning na guia Segurança. Para obter informações sobre os alertas do repositório, confira "Como gerenciar alertas da code scanning para seu repositório".

Nos repositórios em que a code scanning estiver configurada para verificar o código sempre que ele é enviado por push, a code scanning também mapeará os resultados a qualquer solicitação de pull aberta e adicionará os alertas como anotações nos mesmos lugares que as outras verificações de solicitação de pull. Para obter mais informações, confira "Como personalizar a code scanning".

Se o seu pull request for direcionado a um branch protegido que usa code scanning e o proprietário do repositório tiver configurado as verificações de status necessárias, a verificação de "resultados de Code scanning" deve passar antes que você possa fazer o merge do pull request. Para obter mais informações, confira "Sobre os branches protegidos".

Sobre code scanning como uma verificação de pull request

Há muitas opções para configurar code scanning como uma verificação de solicitação de pull. Portanto, a configuração exata de cada repositório irá variar e alguns terão mais de uma verificação.

Verificação de resultados de Code scanning

Para todas as configurações da code scanning, a verificação que contém os resultados da code scanning é: Resultados da Code scanning . Os resultados de cada ferramenta de análise utilizada são mostrados separadamente. Todos os novos alertas gerados por alterações no pull request são exibidos como anotações.

Para ver o conjunto completo de alertas do branch analisado, clique em Exibir todos os alertas do branch. Isso abrirá a exibição completa do alerta em que você poderá filtrar todos os alertas do branch por tipo, severidade, marca etc. Para obter mais informações, confira "Como gerenciar alertas da verificação de código para seu repositório".

Verificação de resultados de Code scanning em uma solicitação de pull

Falhas de verificação de resultados Code scanning

Se a verificação de resultados de code scanning encontrar problemas com uma severidade error, critical ou high, a verificação falhará e o erro será relatado nos resultados da verificação. Se todos os resultados encontrados por code scanning tiverem gravidades menores, os alertas serão tratados como avisos ou observações e a verificação será considerada bem-sucedida.

Ocorreu uma falha na verificação de code scanning em um pull request

Você pode substituir o comportamento padrão nas configurações do repositório especificando o nível de severidades e as severidades de segurança que causarão falha da solicitação de pull. Para obter mais informações, confira "Como personalizar a code scanning".

Outras verificações de code scanning

Dependendo da sua configuração, você poderá ver verificações adicionais em execução em pull requests com code scanning configurados. Estes são geralmente fluxos de trabalho que analisam o código ou que fazem o upload dos resultados de code scanning. Essas verificações são úteis para a resolução de problemas em caso de problemas com a análise.

Por exemplo, se o repositório usar o CodeQL analysis workflow, uma verificação CodeQL/Analisar (LINGUAGEM) será executada para cada linguagem antes que a verificação de resultados seja executada. A verificação de análise pode falhar se houver problemas de configuração ou se o pull request altera a criação para uma linguagem que a análise precisa para compilar (por exemplo, C/C++, C#, ou Java).

Assim como acontece com outras verificações de solicitação de pull, você pode ver detalhes completos da falha de verificação na guia Verificações. Para obter mais informações sobre a configuração e a resolução de problemas, confira "Como personalizar a code scanning" ou "Solução de problemas do fluxo de trabalho do CodeQL".

Visualizando um alerta no seu pull request

Você pode ver os alertas de code scanning introduzidos em uma solicitação de pull na guia Conversa. O Code scanning posta uma revisão de solicitação de pull que mostra cada alerta como uma anotação nas linhas de código que dispararam o alerta. Você pode comentar os alertas, ignorar os alertas e ver os caminhos para os alertas, diretamente nas anotações. Você pode ver os detalhes completos de um alerta clicando no link "Mostrar mais detalhes", que acessa a página de detalhes do alerta.

Anotação de alerta na guia Conversas de uma solicitação de pull

Você também pode ver todos os alertas de code scanning na guia Arquivos alterados da solicitação de pull. Os alertas decode scanning existentes em um arquivo que estão fora da comparação de alterações introduzidas na solicitação de pull só aparecerão na guia Arquivos alterados.

Se você tiver permissão de gravação para o repositório, algumas anotações conterão links com contexto adicional para o alerta. No exemplo acima, na análise do CodeQL, clique no valor fornecido pelo usuário para ver em que ponto os dados não confiáveis entram no fluxo de dados (isso é conhecido como a origem). Nesse caso, você também pode ver o caminho completo do código-fonte do código que usa os dados (o coletor) clicando em Mostrar caminhos. Isto faz com que seja fácil verificar se os dados não são confiáveis ou se a análise não reconheceu uma etapa de sanitização de dados entre a fonte e o destino. Para obter informações sobre como analisar o fluxo de dados usando o CodeQL, confira "Sobre a análise de fluxo de dados".

Para ver mais informações sobre um alerta, os usuários com a permissão de gravação podem clicar no link Mostrar mais detalhes mostrado na anotação. Isso permite que você veja todos os contextos e metadados fornecidos pela ferramenta em uma exibição de alerta. No exemplo abaixo, você pode ver tags que mostram a gravidade, o tipo e as enumerações de fraquezas comuns relevantes (CWEs) para o problema. A vista mostra também quais commits introduziram o problema.

O status e os detalhes na página de alerta refletem apenas o estado do alerta no branch padrão do repositório, mesmo que o alerta exista em outros branches. Você pode ver o status do alerta em branches não padrão na seção Branches afetados no lado direito da página de alerta. Se um alerta não existir no branch padrão, o status do alerta será exibido como "na solicitação de pull" ou "no branch" e será cinza.

Na exibição detalhada de um alerta, algumas ferramentas da code scanning, como a análise do CodeQL, também incluem uma descrição do problema e um link Mostrar mais para obter diretrizes sobre como corrigir seu código.

Descrição do alerta e link para mostrar mais informações

Como comentar um alerta em uma solicitação de pull

Você pode comentar os alertas de code scanning introduzidos pelas alterações em uma solicitação de pull. Os alertas aparecem como anotações na guia Conversa de uma solicitação de pull, fazendo parte de uma revisão de solicitação de pull, e também são mostrados na guia Arquivos alterados. Você só pode comentar os alertas introduzidos pelas alterações em uma solicitação de pull. Os alertas de code scanning existentes, em arquivos que estejam fora das alterações introduzidas na solicitação de pull, aparecerão na guia Arquivos alterados, mas não podem ser comentados.

Você pode exigir que todas as conversas em uma solicitação de pull, incluindo as relacionadas a alertas de code scanning sejam resolvidas antes que a solicitação de pull possa ser mesclada. Para obter mais informações, confira "Sobre os branches protegidos".

Corrigir de um alerta no seu pull request

Qualquer pessoa com acesso push a um pull request pode corrigir um alerta de code scanning que seja identificado nesse pull request. Se você fizer commit de alterações na solicitação do pull request, isto acionará uma nova execução das verificações do pull request. Se suas alterações corrigirem o problema, o alerta será fechado e a anotação removida.

Ignorar um alerta no seu pull request

Uma forma alternativa de fechar um alerta é ignorá-lo. Você pode descartar um alerta se não acha que ele precisa ser corrigido. Por exemplo, um erro no código que é usado apenas para testes ou quando o esforço de corrigir o erro é maior do que o benefício potencial de melhorar o código. Se você tiver permissão de gravação no repositório, o botão Ignorar estará disponível nas anotações de código e no resumo de alertas. Quando você clicar em Ignorar, precisará escolher um motivo para fechar o alerta. Captura de tela do alerta de verificação de código com uma lista suspensa para escolher o motivo enfatizado do alerta ignorado É importante escolher o motivo apropriado no menu suspenso, pois isso pode afetar se uma consulta continua sendo incluída em análise futura. Opcionalmente, você pode comentar sobre um alerta ignorado para registrar o contexto dele. O comentário sobre o alerta ignorado é adicionado à linha do tempo do alerta e pode ser usado como justificativa em auditorias e relatórios. Você pode recuperar ou definir um comentário usando a API REST de verificação de código. O comentário está contido no dismissed_comment do ponto de extremidade alerts/{alert_number}. Para obter mais informações, confira "Verificação de código".

Se você ignorar um alerta de CodeQL como um falso resultado positivo, por exemplo, porque o código usa uma biblioteca de sanitização incompatível, considere contribuir para o repositório de CodeQL e melhorar a análise. Para obter mais informações sobre CodeQL, confira "Contribuir para CodeQL".

Para obter mais informações sobre como ignorar alertas, confira "Como gerenciar alertas de code scanning no repositório".