Skip to main content

Sobre a qualidade do código no GitHub

GitHub Code Quality sinaliza problemas de qualidade de código em solicitações de pull e verificações de repositório, aplica autocorreções com tecnologia de Copilot e aplica padrões com conjuntos de regras.

Quem pode usar esse recurso?

GitHub Team ou GitHub Enterprise Cloud

Observação

          GitHub Code Quality está atualmente em prévia pública e ficará disponível para o público em geral em 20 de julho de 2026.

Durante prévia pública, Code Quality não será cobrado, embora as verificações Code Quality consumam GitHub Actions minutos. A partir de 20 de julho de 2026, o uso incorrerá em encargos. Consulte GitHub Code Quality Faturamento.

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 autocorreções com tecnologia Copilot de um clique.
  • 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. Você também pode impor limites de cobertura com conjuntos de regras para bloquear solicitações de pull que não atendem a uma porcentagem mínima de cobertura ou que fazem com que a cobertura caia mais do que o valor permitido.
  • Carregue relatórios de cobertura de código para ver as métricas de cobertura de teste diretamente em solicitações de pull, ajudando os revisores a identificar o código não testado.
  • 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 está atualmente em prévia pública e ficará disponível para o público em geral em 20 de julho de 2026. Durante prévia pública, as verificações Code Quality consumirão GitHub Actions minutos, mas você não será cobrado por outro uso. A partir de 20 de julho de 2026, o uso incorrerá em encargos adicionais. Confira GitHub Code Quality Faturamento.

Se você quiser evitar encargos, desabilite Code Quality antes de 20 de julho de 2026. Confira Desabilitar GitHub Code Quality.

Observação

Você não precisa de uma Copilot ou uma licença Code Security para usar Code Quality ou aplicar autocorreções com tecnologia de 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 CodeQL baseada em regras que verifica toda a base de código e as solicitações de pull, essa análise impulsionada por IA examina apenas os arquivos enviados recentemente para a ramificação padrão e pode identificar problemas em idiomas além dos listados anteriormente. Para saber mais, confira Cartão do aplicativo: recursos de IA do GitHub para segurança e qualidade.

Onde as descobertas serão exibidas?

Depois de habilitar Code Quality para um repositório, você verá verificações CodeQL 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 na ramificação 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 Autofixo do Copilot sugestão sobre como corrigir o problema. Confira Corrigindo problemas de qualidade do código antes de mesclar sua solicitação de pull.

Se você tiver configurado a cobertura de código, o github-code-quality[bot] também publica um resumo da cobertura que mostra a porcentagem agregada de cobertura da ramificação do PR em comparação com a ramificação padrão. Confira Interpretando os resultados da qualidade do código do seu repositório.

Resultados da ramificação padrão

As descobertas de Code Quality na ramificação padrão são relatadas em páginas "Qualidade do código" na guia Security and quality do repositório:

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".

Como a habilitação funciona em toda a sua empresa

Code Quality é controlado em três níveis, para que você possa decidir quanta autonomia fornecer às organizações e repositórios:

  • Empresa: O proprietário da empresa deve primeiro habilitar Code Quality para a empresa. Até que o façam, os proprietários da organização não poderão habilitá-lo.
  • Organização: Os proprietários da organização controlam quais repositórios habilitaram ou desabilitaram Code Quality , concedendo acesso a todos os repositórios, uma lista selecionada ou repositórios que correspondem a um filtro. Eles também podem impor essas configurações para que os administradores do repositório não possam alterá-las.
  • Repositório: Os administradores do repositório podem habilitar ou desabilitar Code Quality para repositórios individuais, a menos que a imposição no nível da organização se aplique.

Quando Code Quality está habilitado em um repositório, a análise de CodeQL é executada por meio de GitHub Actions e exibe resultados em pull requests e no branch padrão. Os desenvolvedores veem verificações de qualidade e anotações em suas solicitações de pull.

Acesso ao repositório no nível da organização

No nível da organização, você controla Code Quality com uma única configuração de acesso do Repositório . Essa configuração determina quais repositórios Code Quality habilitaram e quais os têm desabilitados: os repositórios dentro de sua seleção estão habilitados e os repositórios fora da seleção estão desabilitados.

Importante

Alterar a configuração de acesso ao Repositório pode habilitar e desabilitar Code Quality em vários repositórios ao mesmo tempo. Por exemplo, se você habilitar Code Quality para repositórios correspondentes a um filtro, qualquer repositório que não corresponda ao filtro será desabilitado. Antes de sua alteração ser aplicada, uma caixa de diálogo mostra o número total de repositórios habilitados e desabilitados, juntamente com o impacto da cobrança.

Opções de acesso ao repositório

Você pode aplicar uma das seguintes opções de cada vez.

OpçãoBehavior
Nenhum repositórioDesabilita Code Quality em todos os repositórios atuais e futuros da organização.
Permitir que os repositórios decidamA organização não habilita nem desabilita Code Quality. Os administradores do repositório escolhem se devem habilitá-lo para seus próprios repositórios. Essa opção não pode ser imposta.
Todos os repositóriosHabilita Code Quality para todos os repositórios atuais e futuros.
Repositórios selecionados
Code Quality Habilita uma lista específica de repositórios que você escolher. Os repositórios que você não selecionar estão desabilitados e os novos repositórios não são habilitados automaticamente. Ideal para projetos-piloto ou exceções.
Correspondendo a um filtroHabilita os repositórios Code Quality que correspondem a um filtro que você define, agora e no futuro. Os repositórios que não correspondem estão desabilitados. Consulte repositórios de filtragem.

Filtrando repositórios

Ao escolher Correspondência com um filtro, você cria um filtro dinâmico que habilita automaticamente Code Quality para repositórios existentes e futuros que correspondem aos critérios definidos. Isso é útil para a governança contínua em escala.

Você pode filtrar qualquer combinação dos seguintes critérios:

  • Visibilidade: Se os repositórios são públicos, privados ou internos. Útil para políticas amplas, como habilitar Code Quality para todos os repositórios privados.
  • Status do fork: Indica se os repositórios são forks. Útil quando as bifurcações não devem consumir recursos de análise.
  • Propriedade personalizada: Se os repositórios têm um valor de propriedade personalizado específico. Por exemplo, você pode direcionar repositórios com uma team:platform propriedade.

Todas as condições em um filtro são combinadas com AND, portanto, um repositório deve atender a todas as condições para ser habilitado. Você também pode excluir repositórios que correspondem a condições específicas.

Controlando o acesso

Por padrão, os administradores do repositório podem alterar as configurações Code Quality dos próprios repositórios. Para evitar isso, habilite Exigir acesso.

Bloqueios de imposição nos estados habilitados e desabilitados definidos pela opção de acesso ao Repositório , portanto, os administradores do repositório não podem substituí-los. Isso melhora a consistência em toda a sua organização, mas reduz a flexibilidade para administradores individuais do repositório.

  • A imposição se aplica à maioria das opções de acesso do Repositório selecionadas, incluindo Nenhum repositório, que impõe como desabilitado Code Quality .
  • A aplicação não está disponível com Permitir que os repositórios decidam, o que deixa intencionalmente a escolha para os administradores do repositório.

Planejando sua implementação

Como a habilitação Code Quality pode afetar muitos repositórios ao mesmo tempo e cada análise consome GitHub Actions minutos, planeje como você a distribui em toda a sua organização:

  • Comece com um grupo piloto. Habilite um conjunto pequeno e representativo de repositórios primeiro, por exemplo, selecionando-os individualmente ou correspondendo a uma propriedade personalizada, para que você possa validar os resultados antes de expandir.
  • Verifique sua GitHub Actions capacidade. Confirme se os runners podem absorver a carga adicional antes de habilitar Code Quality em larga escala.
  • Decida se deseja impor a habilitação. A imposição oferece uma cobertura consistente e impede que os administradores do repositório optem por não aceitar, mas isso remove a flexibilidade deles. Deixar a aplicação desativada durante uma fase piloto permite que as equipes escolham aderir ou não à medida que aprendem.
  • Expanda depois que os resultados forem confiáveis. Depois de confirmar que a análise é executada sem problemas e os desenvolvedores entenderem as descobertas, amplie sua seleção ou filtro para cobrir mais repositórios.

Próximas etapas