Você pode habilitar Code Quality para um único repositório ou para cada repositório em uma organização de uma só vez. Ativar no nível da organização garante a todas as suas equipes um padrão de qualidade consistente com uma única mudança, enquanto ativar por repositório permite focar em projetos específicos ou implementar gradualmente.
Pré-requisitos
- Um proprietário da empresa deve ter permitido Code Quality em sua empresa. Confira Permitindo o uso de GitHub Code Quality na sua empresa.
- GitHub Actions deve ser habilitado porque Code Quality usa ações para executar cada CodeQL análise.
- Para obter todo o benefício do recurso, seu repositório deve incluir um dos idiomas compatíveis com a análise de qualidade por CodeQL. Consulte os idiomas com suporte.
Habilitando Code Quality para seu repositório
-
Em GitHub, acesse a página principal do repositório.
-
No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na barra lateral, em "Segurança", clique Qualidade do código para exibir a página "Qualidade do código".
-
Clique em Habilitar qualidade do código.
-
Examine as informações na página de qualidade do código:
- Idiomas: Se você quiser desabilitar CodeQL a análise de qualquer um dos idiomas, desmarque a caixa de seleção associada.
- Tipo de executor: Se você quiser usar um executor diferente, escolha o executor rotulado e defina o rótulo Runner. Confira Usar executores hospedados no GitHub e Usar rótulos com os executores auto-hospedados.
-
Clique em Salvar alterações para salvar sua configuração.Code Quality
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. Confira Como dar aos recursos de segurança acesso a registros privados.
Habilitando Code Quality para sua organização
No nível da organização, você controla Code Quality com uma única configuração de acesso do Repositório . Isso oferece opções detalhadas, desde habilitar todos os repositórios até segmentar uma lista específica ou usar um filtro dinâmico, para que você possa testar Code Quality intencionalmente e implementá-lo gradualmente no seu próprio ritmo. Os repositórios em sua seleção estão habilitados e os repositórios fora da seleção estão desabilitados.
Para obter as opções de acesso disponíveis e como a filtragem e a imposição funcionam, consulte Capacitação em qualidade de código em organizações e empresas.
-
Em GitHub, acesse a página principal da organização.
-
No nome da organização, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na barra lateral, em "Segurança", clique em Qualidade do código.
-
Em "Acesso ao repositório", selecione uma opção no menu suspenso.
- Se você selecionou repositórios selecionados..., escolha os repositórios que deseja habilitar.
- Se você selecionou a correspondência de um filtro..., defina o filtro.
-
Opcionalmente, para impedir que os administradores de repositório alterem essas configurações, habilite Impor acesso.
-
Se a alteração habilitar ou desabilitar Code Quality em quaisquer repositórios, uma caixa de diálogo "Examinar alterações de habilitação e cobrança" será exibida, mostrando o número total de repositórios habilitados e desabilitados e os custos associados. Examine os detalhes e clique em Confirmar.
Suas alterações são salvas automaticamente e começam a se propagar imediatamente. Em grandes organizações, pode levar vários minutos para que as alterações sejam aplicadas em todos os repositórios.
Se você estiver distribuindo o recurso em várias equipes, recomendamos que você pilote em um grupo pequeno e ajuste seus limites de qualidade antes de habilitar em todos os lugares. Confira Implementando GitHub Code Quality em larga escala.
Próximas etapas
- Adicione a cobertura de código: Envie os dados de cobertura de código gerados pela sua suíte de testes para ver os resultados da cobertura diretamente nos pull requests. Confira Configurando a cobertura de código para seu repositório.
- Para sua organização: Entenda a integridade do código de seus repositórios rapidamente. Confira Explorando os resultados de qualidade de código do GitHub em sua organização.