Qualidade do Código do GitHub

GitHub Code Quality analisa o código em busca de problemas de qualidade e cobertura e oferece correções da plataforma Copilot que você pode aplicar com um clique. Ele é executado em dois lugares:

• Em pull requests, Code Quality usa regras determinísticas CodeQL para detectar antipadrões conhecidos e publica os resultados como comentários inline antes que o código seja mesclado. Se você fizer upload de um relatório XML de cobertura do Cobertura, as métricas de cobertura por linha mostram se uma alteração mantém ou reduz a cobertura. Você pode aplicar limites mínimos de qualidade e cobertura usando conjuntos de regras para bloquear pull requests que não atendam aos seus critérios, evitando o acúmulo de nova dívida de qualidade.

•           **Na ramificação padrão**, as verificações baseadas em regras identificam a dívida de qualidade existente na base de código, com correções automáticas que você pode aplicar diretamente ou atribui-la ao Copilot cloud agent para resolvê-la em seu nome. A análise alimentada por IA também é executada em arquivos alterados recentemente, sinalizando problemas que estão fora dos conjuntos de regras existentes, incluindo idiomas ainda não cobertos por CodeQL consultas.
  

Casos de uso

Veja como GitHub Code Quality funciona na prática.

Para desenvolvedores e equipes:

• Um desenvolvedor abre uma solicitação de pull que introduz um problema de confiabilidade ou de manutenção. Code Quality publica um comentário explicando o problema e oferece uma correção de um clique antes que o código seja mesclado. O desenvolvedor também vê um relatório com métricas de cobertura de linha e pode identificar de imediato se o pull request aumenta ou reduz a cobertura em comparação com o branch padrão.
• Uma equipe herda uma grande base de código com anos de dívida de qualidade acumulada. Code Quality examina a ramificação padrão, revela os resultados com correções automáticas em um painel, e a equipe atribui o trabalho de correção a Copilot cloud agent para abrir automaticamente pull requests de correção.
• Uma equipe passa a usar assistentes de programação com IA e precisa ter a garantia de que o código gerado atende ao mesmo padrão que o código escrito manualmente. A análise com tecnologia de IA identifica problemas nos arquivos modificados recentemente que as consultas baseadas em regras não foram criadas para detectar, enquanto as regras CodeQL cobrem antipadrões bem definidos.

Para administradores e clientes potenciais:

• Um líder de engenharia define limites de cobertura e qualidade usando conjuntos de regras. Pull requests que não atendam aos critérios são impedidas de se mesclar, logo, nenhuma nova dívida de qualidade ou cobertura se acumula.
• Um administrador precisa de visibilidade entre repositórios para auditorias ou relatórios de conformidade. Code Quality apresenta relatórios na visão geral de segurança, juntamente com as ferramentas de segurança, para que possam ver a postura atual de qualidade em toda a organização, analisar como as conclusões em aberto mudaram ao longo do tempo e identificar quais repositórios precisam de atenção. Consulte Explorando os resultados de qualidade de código do GitHub em sua organização.

Disponibilidade e cobrança

Os custos de uso são determinados por:

• Um valor de licença por estação com base em committers ativos.

•           As correções automáticas da plataforma do Copilot para conclusões encontradas em pull requests e na ramificação padrão, além de detecções da plataforma IA em código mesclado recentemente, que consomem GitHub AI Credits (não é necessária uma licença do Copilot).
  

• GitHub Actions minutos para exames determinísticos CodeQL, se você não usar executores auto-hospedados.

Recursos opcionais, como delegar a Copilot o trabalho de remediação da qualidade do código, exigem uma licença Copilot.

Para obter mais informações, consulte GitHub Code Quality Faturamento.

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 com tecnologia de IA no código alterado recentemente do seu repositório, incluindo linguagens além das suportadas por consultas baseadas em regras.

Próximas Etapas 

• Saiba como corrigir as descobertas de qualidade do código em sua solicitação de pull. Consulte Impedindo que problemas de qualidade de código atinjam seu branch padrão.