close
Skip to main content

Sobre a qualidade do código no GitHub

Use GitHub Code Quality para sinalizar problemas de qualidade de código em pull requests e verificações de repositório, aplicar autofixos com tecnologia de Copilot, e impor padrões através de conjuntos de regras.

Quem pode usar esse recurso?

GitHub Team ou GitHub Enterprise Cloud

Observação

GitHub Code Quality está atualmente em versão prévia pública e sujeito a alterações. Durante versão prévia pública, Code Quality não será cobrado, embora as verificações de Code Quality consumirão GitHub Actions minutos.

Visão geral

          GitHub Code Quality ajuda a garantir que sua base de código seja confiável, mantenedível e eficiente. Se você estiver criando um novo recurso, reduzindo a dívida técnica ou relatando a integridade do repositório, Code Quality fornece insights acionáveis e correções automatizadas para que você possa melhorar e manter a integridade do código do repositório com eficiência.

Principais recursos e benefícios

Com Code Quality, você pode:

  • Identifique riscos e oportunidades de qualidade de código em solicitações de pull e por meio de verificações de repositório.
  • Revise explicações claras sobre descobertas e aplique autofixos potentes com um cliqueCopilot.
  • Use painéis de repositório para acompanhar as pontuações de confiabilidade e manutenção, identificar áreas que precisam de atenção e priorizar a correção.
  • Monitore os painéis da organização para entender a integridade do código de seus repositórios rapidamente e determinar quais repositórios investigar mais detalhadamente.
  • Configure conjuntos de regras para pull requests a fim de impor padrões de qualidade de código e bloquear alterações que não atendam aos seus critérios.
  • Atribua facilmente o trabalho de correção a agente de nuvem Copilot, se você tiver uma Copilot licença.

Custos de disponibilidade e uso

          GitHub Code Quality está disponível para repositórios de propriedade da organização nos planos GitHub Team e GitHub Enterprise Cloud.

          GitHub Code Quality não será cobrado durante a visualização pública. No entanto, Code Quality as verificações consumirão GitHub Actions minutos. Confira [AUTOTITLE](/billing/concepts/product-billing/github-code-quality).

Observação

  • Você não precisa de uma Copilot ou uma Code Security licença para usar Code Quality ou aplicar autofixos alimentados por Copilot.

Idiomas com suporte

          Code Quality executa a análise baseada em regras dos seguintes idiomas usando CodeQL:
  • C#

  • Go

  • Java

  • JavaScript

  • Python

  • Ruby

  • TypeScript

            Code Quality também realiza análise alimentada por IA com os resultados exibidos separadamente no painel do repositório "**Descobertas de IA**". Ao contrário da análise baseada em CodeQL regras que verifica toda a base de código e os pull requests, essa análise impulsionada por IA examina apenas os arquivos enviados recentemente para o branch padrão e pode identificar problemas em idiomas além dos listados anteriormente. Para saber mais, confira [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
    

Onde as descobertas serão exibidas?

Depois de habilitar Code Quality para um repositório, você verá CodeQL escaneamentos para:

  • Toda nova pull request aberta na ramificação padrão
  • Todas as pull requests existentes na ramificação padrão quando são atualizadas, acionando uma nova execução de testes de CI
  • A base de código inteira no branch padrão na hora e na data mostradas na página de configurações "Qualidade do código"

Além disso, você verá uma análise baseada em IA de todos os envios por push recentes para a ramificação padrão.

Resultados de pull requests

Quando CodeQL encontrar problemas baseados em regras em solicitações de pull, você verá comentários do github-code-quality[bot]. Sempre que possível, cada comentário incluirá uma Copilot Autofix sugestão sobre como corrigir o problema. Confira Corrigindo problemas de qualidade do código antes de mesclar sua solicitação de pull.

Resultados da ramificação padrão

          Code Quality as descobertas no branch padrão são relatadas em páginas "Qualidade do código" na guia **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** do repositório:

* ** Descobertas padrão ** mostra os resultados da análise de qualidade CodeQL. Confira Aprimorando a qualidade do código do repositório. * ** Descobertas de IA ** mostra os resultados da análise baseada em IA dos arquivos mais recentemente enviados para o branch padrão. Confira Aprimorando a qualidade do código mesclado recentemente com a IA.

Informações de verificação

Cada CodeQL análise usará GitHub Actions minutos e poderá ser vista na guia Ações do repositório como uma execução do fluxo de trabalho dinâmico "Qualidade do Código".

Próximas etapas

  • Para o seu repositório: **** Ative-o para começar a gerar resultados. Confira Habilitar o GitHub Code Quality.
  •         **Para sua empresa:** Verifique se os repositórios em sua empresa podem habilitar Code Quality. Confira [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).