Skip to main content

Editar as definições da configuração padrão

É possível editar a definição existente da configuração padrão para code scanning para melhor atender às suas necessidades de segurança de código.

A Code scanning está disponível para todos os repositórios públicos do GitHub.com. A Code scanning também está disponível em repositórios privados pertencentes às organizações que usam o GitHub Enterprise Cloud e que têm uma licença do GitHub Advanced Security. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

Sobre a edição das definições da configuração padrão

Depois de executar uma análise inicial do código com a configuração padrão, talvez seja necessário fazer alterações na configuração para atender melhor às necessidades de segurança do código. Para configurações existentes da instalação padrão, você pode editar:

  • Quais linguagens a configuração padrão analisará
  • O conjunto de consultas é executado durante a análise. Para obter mais informações sobre os pacotes de consultas disponíveis, confira "Conjuntos de consultas internos do CodeQL".

Se sua base de código depender de uma biblioteca ou estrutura que não seja reconhecida pelas bibliotecas padrão incluídas com o CodeQL, você também poderá estender a cobertura do CodeQL na configuração padrão usando pacotes de modelos do CodeQL. Para obter mais informações, consulte "Estendendo a cobertura do CodeQL com pacotes de modelos do CodeQL na configuração padrão".

Se você precisar alterar quaisquer outros aspectos da configuração code scanning, considere configurar a instalação avançada. Para obter mais informações, confira "Como definir a configuração avançada da verificação de código".

Personalizar a definição existente da configuração padrão

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

  2. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Segurança" da barra lateral, clique em Segurança de código e análise.

  4. Na linha "análise de CodeQL" da seção do "Code scanning", selecione , em seguida clique em Exibir configuração do CodeQL.

  5. Na janela de configuração padrão do "CodeQL", clique em Editar.

  6. Opcionalmente, na seção "Linguagens", selecione ou desmarque as linguagens para análise.

  7. Opcionalmente, na seção "Conjuntos de consultas", selecione um conjunto de consultas diferente para executar em seu código.

  8. Para atualizar sua configuração, bem como executar uma análise inicial do seu código com a nova configuração, clique em Salvar alterações. Todas as análises futuras usarão sua nova configuração.

Estendendo a cobertura do CodeQL com pacotes de modelos do CodeQL na configuração padrão

Observação: pacotes de modelos estão atualmente em versão beta e sujeitos a alterações. Durante a versão beta, os pacotes de modelos são compatíveis apenas com análises Java.

Se você usar estruturas e bibliotecas não reconhecidas pelas bibliotecas padrão incluídas com o CodeQL, poderá modelar suas dependências e estender as análises do code scanning. Para obter mais informações, consulte Linguagens e estruturas com suporte na documentação do CodeQL.

Para a configuração padrão, você precisa definir os modelos de suas dependências adicionais em um pacote de modelos do CodeQL em seu repositório. Para obter mais informações sobre pacotes de modelos do CodeQL e como escrever seus próprios pacotes, consulte Usando o editor de modelos do CodeQL, na documentação do CodeQL.

Para usar pacotes de modelos do CodeQL com a configuração padrão, coloque-os no diretório .github/codeql/extensions. Eles serão automaticamente detectados e usados na sua análise do code scanning. Se você alterar posteriormente sua configuração para usar a instalação avançada, todas as extensões de dados no diretório .github/codeql/extensions ainda serão reconhecidas e usadas.