Skip to main content

Propriedades do repositório para code scanning

Você pode usar as propriedades do repositório para ajustar code scanning para atender às suas necessidades.

Pré-requisitos

Para que as propriedades do repositório descritas aqui tenham efeito, é necessário ter configurado code scanning. Consulte Sobre os tipos de instalação para verificação de código.

As propriedades do repositório que afetam code scanning devem ser criadas manualmente para a sua organização. Em seguida, você pode definir valores para eles que se aplicam a toda a sua organização ou permitir que eles sejam configurados de forma diferente para cada repositório. Consulte Como gerenciar propriedades personalizadas para repositórios na sua organização.

Propriedades do repositório compatíveis com code scanning

Algumas funcionalidades do code scanning podem ser configuradas usando propriedades do repositório. As organizações podem usar propriedades de repositório para impor configurações em todos os repositórios e para repositórios individuais. Se code scanning for personalizado por meio das propriedades do repositório, a personalização se aplica a todos os tipos de configuração.

A seguir, apresentamos uma visão geral das propriedades do repositório que você pode definir e que afetam as análises de code scanning quando configuradas:

NomeTipo
github-codeql-extra-queriesTexto
github-codeql-disable-overlayVerdadeiro/Falso
github-codeql-file-coverage-on-prsVerdadeiro/Falso

Observação

As propriedades do repositório compatíveis dependem da versão do github/codeql-action utilizada nas suas análises code scanning. Para a configuração avançada de code scanning, verifique se o seu fluxo de trabalho está fazendo referência à versão principal mais recente. Code scanning A configuração padrão utiliza automaticamente a versão mais recente.

Personalização de análise

A github-codeql-extra-queries propriedade permite que você configure consultas adicionais que devem ser executadas. Isso é útil para adicionar consultas a todas as análises relevantes em sua organização sem a necessidade de modificar fluxos de trabalho individuais ou mudar para uma configuração avançada. Isso aceita os mesmos valores que a queries entrada do github/codeql-action. Consulte Opções de configuração de fluxo de trabalho para verificação de código.

Habilitar ou desabilitar funcionalidades

Você pode desabilitar uma análise incremental aprimorada definindo a github-codeql-disable-overlay propriedade como true. Isso pode ser útil se uma análise incremental aprimorada estiver falhando devido ao aumento dos requisitos de hardware.

As informações de cobertura de arquivo não são calculadas para análises de solicitações de pull. Se você quiser habilitar as informações de cobertura de arquivo para solicitações de pull, poderá definir a github-codeql-file-coverage-on-prs propriedade como true.