Análise do CodeQL para Qualidade de Código

Informações sobre como funciona a análise alimentada por CodeQL, o fluxo de trabalho utilizado e as verificações de status registradas nos pull requests.

Neste artigo

CodeQLAnálise de energia

Code Quality usa CodeQL para executar a análise de solicitações de pull e de seu branch padrão com base em regras.

  • As descobertas do branch padrão aparecem no painel "Descobertas padrão" na guia do Security and quality repositório.

  • As descobertas sobre solicitações de pull aparecem como comentários feitos por github-code-quality[bot].

Autofixo do Copilot as sugestões são fornecidas para descobertas onde possível.

Informações de verificação

Cada CodeQL análise consumirá GitHub Actions minutos e pode ser visualizada na guia Ações do repositório. Essas execuções usam o nome do fluxo de trabalho CodeQL, o mesmo nome que code scanning usa, portanto não é possível distinguir as execuções Code Quality das code scanning de forma confiável pelo nome do fluxo de trabalho. Identifique Code Quality as execuções pelo GitHub Actions rótulo, por exemplo, "Qualidade do Código: efetuar push no principal"

Listas de consultas para idiomas com suporte

Cada Code Quality regra é escrita como uma consulta em CodeQL e, em seguida, executada usando GitHub Actions.

As regras são continuamente refinadas por GitHub e desenvolvedores de código aberto.

Para obter mais informações sobre o CodeQL projeto, consulte https://codeql.github.com/.

Fluxo de trabalho usado para análise de qualidade de código

Você pode ver todas as execuções de workflows para Code Quality na guia Ações do seu repositório. Você pode identificar Code Quality execuções por seu GitHub Actions rótulo, por exemplo "Code Quality: push on main"

Por padrão, o fluxo de trabalho Qualidade do Código é executado em executores GitHub padrão, mas você pode configurar Code Quality para usar executores com um rótulo específico. Elas podem ser hospedadas por GitHub ou auto-hospedadas.

Se sua organização tiver configurado o cache de registros privados, eles estarão disponíveis para análise de qualidade de código a ser usada para resolver dependências.

Para obter mais informações, consulte:

Verificações de status do pull request

Quando a análise de qualidade do código é executada em uma solicitação de pull, a verificação "CodeQL – Qualidade do Código /Analisar" é mostrada na seção "Verificações" na parte inferior da solicitação de pull.

Todos os problemas de código identificados pela verificação são relatados em comentários sobre a solicitação de pull. O comentário é feito pelo github-code-quality[bot] e inclui uma Autofixo do Copilot sugestão.

Falhas de verificação de status

O fluxo de trabalho falhou em ser executado. Por exemplo, seu orçamento para minutos de ações está esgotado. ** Consulte como visualizar logs para diagnosticar falhas.

A mesclagem está bloqueada: foram detectados problemas de qualidade de código

A verificação encontrou problemas no código que excedem o limite de qualidade definido por uma regra de ramificação de qualidade de código do repositório. Você precisa resolver esses problemas antes de integrar o pull request. Confira Resolvendo um bloqueio em sua pull request.