Sobre a varredura de código de CodeQL no seu sistema de CI

Você pode analisar o seu código com CodeQL em um sistema de integração contínua de terceiros e fazer o upload dos resultados para your GitHub Enterprise Server instance. Os alertas de Varredura de código resultantes são exibidos junto com todos os alertas gerados dentro de GitHub Enterprise Server.

Varredura de código está disponível para repositórios de organizações onde Segurança Avançada GitHub está habilitado. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Observação: O administrador do site deve habilitar Varredura de código para your GitHub Enterprise Server instance antes de usar este recurso. Para obter mais informações, consulte "Configurar o Varredura de código para seu aplicativo ".

Sobre CodeQL Varredura de código no seu sistema de CI

Varredura de código é um recurso que você usa para analisar o código em um repositório de GitHub para localizar vulnerabilidades de segurança e erros de codificação. Quaisquer problemas identificados pela análise são exibidos em GitHub Enterprise Server. Para obter informações, consulte "Sobre Varredura de código com CodeQL."

Você pode executar CodeQL Varredura de código em GitHub Enterprise Server usando GitHub Actions. Como alternativa, se você usar um sistema de integração contínua ou um sistema de entrega/Continuous Delivery (CI/CD) de terceiros você poderá executar a análise CodeQL no seu sistema existente e enviar os resultados para your GitHub Enterprise Server instance.

Se você adicionar CodeQL CLI ou Executor do CodeQL ao seu sistema de terceiros, chame a ferramenta para analisar o código e fazer o upload dos resultados SARIF para GitHub Enterprise Server. Os alertas de Varredura de código resultantes são exibidos junto com todos os alertas gerados dentro de GitHub Enterprise Server.

Observação: Fazer o upload dos dados SARIF para exibir como resultados de Varredura de código em GitHub Enterprise Server é compatível com repositórios de organizações com Segurança Avançada GitHub habilitado. Para obter mais informações, consulte "Gerenciar configurações de segurança e análise do seu repositório".

Comparar CodeQL CLI e Executor do CodeQL

O CodeQL CLI é um produto inependente que você pode usar para analisar o código. Seu principal propósito é gerar uma representação do banco de dados de uma base de código, um banco de dados de CodeQL. Assim que o banco de dados estiver pronto, você poderá consultá-lo interativamente, ou executar um conjunto de consultas para gerar um conjunto de resultados no formato SARIF e fazer o upload dos resultados para your GitHub Enterprise Server instance.

A Executor do CodeQL é uma ferramenta de linha de comando que utiliza o CodeQL CLI para analisar o código e fazer o upload dos resultados para GitHub Enterprise Server. A ferramenta imita a análise executada nativamente dentro de GitHub Enterprise Server usando ações. O executor é capaz de integrar-se a ambientes de compilação mais complexos do que o CLI, mas esta capacidade torna mais difícil e suscetível de erros de configuração. É também mais difícil depurar quaisquer problemas. De modo geral, é melhor usar CodeQL CLI diretamente a menos que não seja compatível com o seu caso de uso.

Use CodeQL CLI para analisar:

  • Linguagens dinâmicas, por exemplo, JavaScript e Python.
  • Bases de código com uma linguagem compilada que pode ser construída com um único comando ou executando um único script.

Para obter mais informações, consulte "Instalar CodeQL CLI no seu sistema de CI".

Você precisará usar Executor do CodeQL se precisar:

  • Configurar o sistema de CI para orquestrar as invocações do compilador, bem como executar a análise de CodeQL.
  • Analisar mais de uma linguagem em um repositório.

Note: The Executor do CodeQL is being deprecated. Please use the CodeQL CLI version 2.6.2 or greater instead. GitHub Enterprise Server 3.3 will be the final release series that supports the Executor do CodeQL. On GitHub Enterprise Cloud, the Executor do CodeQL will be supported until March 2022. For more information, see the CodeQL runner deprecation.

Para obter mais informações, consulte "Executar o Executor do CodeQL no seu sistema de CI".

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.