Pré-requisitos
Para que as propriedades do repositório descritas aqui tenham um efeito, você precisa 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 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.
Testar alterações antes de aplicá-las
Talvez você queira testar se as configurações aplicadas por meio de propriedades do repositório têm os efeitos desejados antes de distribuí-las para toda a sua organização. As propriedades do repositório podem ser definidas como valores específicos para repositórios individuais. Se você estiver configurando uma propriedade de repositório pela primeira vez, crie-a para sua organização, mas não a defina como um valor. Em vez disso, defina-o como um valor para um repositório de teste específico em que você possa validar a alteração primeiro. Depois de validado em um repositório de teste, você pode definir o valor para toda a sua organização ou os repositórios desejados.
Ao alterar o valor de uma propriedade de repositório com suporte, você pode usar a mesma abordagem. Substitua ou defina o valor da propriedade do repositório para um repositório de teste, valide a alteração e, em seguida, implemente-a para sua organização ou outros repositórios.
Propriedades do repositório com suporte para code scanning
Algumas code scanning funcionalidades 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 usando as propriedades do repositório, a personalização se aplicará a todos os tipos de instalação.
Veja a seguir uma visão geral das propriedades do repositório que você pode configurar que afetam code scanning as análises quando configuradas:
| Nome | Tipo |
|---|---|
github-codeql-config-file | Texto |
github-codeql-extra-queries | Texto |
github-codeql-disable-overlay | Verdadeiro/Falso |
github-codeql-file-coverage-on-prs | Verdadeiro/Falso |
github-codeql-tools | Texto |
Observação
As propriedades do repositório com suporte dependem da versão do github/codeql-action que é usada por suas code scanning análises. Para code scanning configuração avançada, verifique se o fluxo de trabalho está fazendo referência à versão principal mais recente. Code scanning A configuração padrão usa automaticamente a versão mais recente.
Arquivos de configuração personalizados
Você pode definir a github-codeql-config-file propriedade para o caminho local ou remoto de um arquivo de configuração. Os valores aceitos para essa propriedade são os mesmos config-file do parâmetro da ação codeql-action/init . Para obter mais informações sobre formatos de caminho aceitos e possíveis conteúdos de arquivos de configuração, consulte Opções de configuração de fluxo de trabalho para verificação de código.
Um valor especificado para a github-codeql-config-file propriedade será aplicado à configuração padrão e code scanning à code scanning configuração avançada. Se um fluxo de trabalho de instalação avançado especificar uma entrada explícita para o config-file parâmetro da ação codeql-action/init , essa entrada terá precedência sobre o valor configurado na propriedade do repositório. Isso permite que fluxos de trabalho avançados usem configurações diferentes daquelas aplicadas aos fluxos de trabalho de instalação padrão, se desejado.
Um arquivo de configuração personalizado aplicado usando a github-codeql-config-file propriedade é mesclado com a configuração que code scanning a configuração padrão gera automaticamente.
Code scanning A configuração padrão permite personalizar algumas configurações de análise na interface do usuário, como quais modelos de ameaças ou CodeQL pacotes de modelo usar. Essas seleções são mantidas na configuração mesclada: os modelos de ameaça selecionados na interface do usuário de configuração padrão são combinados com todos os modelos de ameaça especificados no arquivo de configuração e os pacotes de modelo configurados na interface do usuário são mantidos. Consulte Sobre os tipos de instalação para verificação de código para obter mais informações sobre as opções de configuração disponíveis na code scanning configuração padrão.
Outra 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.
Por padrão, code scanning as análises usam a versão mais recente lançada do CodeQL. Geralmente, não é recomendável alterar isso, a menos que você esteja encontrando um problema específico que seja resolvido alternando para uma versão diferente. Se você precisar alterar isso, a github-codeql-tools propriedade permitirá que você especifique uma versão diferente.
Se um fluxo de trabalho de instalação avançado especificar uma entrada explícita para o tools parâmetro da ação codeql-action/init , essa entrada terá precedência sobre o valor configurado na propriedade do repositório. Isso permite que fluxos de trabalho avançados usem configurações diferentes daquelas aplicadas aos fluxos de trabalho de instalação padrão, se desejado. Para impor o valor da propriedade do repositório a fluxos de trabalho de instalação avançados, mesmo que eles tenham uma entrada explícita tools , adicione um ! prefixo ao valor da propriedade do repositório. Por exemplo, !nightly impõe que todos os fluxos de trabalho usem a versão mais recente nightly .
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.