Definindo limites de qualidade de código para solicitações de pull

Introdução

Você pode bloquear solicitações de pull que não atendem aos seus padrões de qualidade de código, adicionando a regra de branch Exigir resultados de qualidade de código a um conjunto de regras e especificando o nível de severidade que você precisa. Se uma solicitação de pull não atingir esse limite, ela não poderá ser mesclada.

Pré-requisitos

• Code Quality está habilitado. Confira Habilitar o GitHub Code Quality
• Código em um idioma com suporte. Consulte os idiomas com suporte.

Confirmando que Code Quality é executado com êxito em solicitações de pull

Antes de adicionar ou atualizar um conjunto de regras para incluir um limite para Code Quality, confirme se o fluxo de trabalho Qualidade do Código está em execução e relatando resultados de volta às solicitações de pull. Caso contrário, o conjunto de regras poderá bloquear a mesclagem de todas as solicitações de pull.

1. Abra uma solicitação de pull recente e role até o resumo "Verificações" na parte inferior da solicitação de pull.
2. Confirme se a verificação "CodeQL – Qualidade do Código" foi executada com êxito e informou seu status.

Para saber mais, confira Análise do CodeQL para Qualidade de Código.

Adicionando ou atualizando um conjunto de regras para incluir Code Quality

1. Navegue até a guia "Configurações" do repositório.
2. Na barra lateral esquerda, em "Código e automação", expanda Regras e clique em Conjuntos de regras.
3. Se você ainda não tiver um conjunto de regras para proteger seu branch padrão, expanda Novo conjunto de regras e clique em Novo conjunto de regras de branch. Como alternativa, abra o conjunto de regras existente para o branch padrão e prossiga para a etapa 5.
4. Se você estiver criando um novo conjunto de regras:
   • Defina um nome para o conjunto de regras.
   • Defina o "status de imposição" como "Ativo".
   • Em "Ramificações de destino", adicione como alvo "Incluir ramificação padrão".
5. Em "Regras de ramo", habilite "Exigir resultados de qualidade de código".
6. Defina "Severidade" para estabelecer o nível mínimo de severidade dos resultados de qualidade de código que devem ser resolvidos antes que uma solicitação de pull possa ser mesclada na ramificação padrão. Por exemplo:
   • Defina "Erros" para bloquear solicitações de pull quando houver erros de qualidade de código não resolvidos sendo mesclados.
   • Defina "Avisos e superiores" para bloquear solicitações de pull com avisos ou erros de qualidade de código não resolvidos sendo mesclados.
   • Defina "Observações e superiores" para bloquear solicitações de pull com observações, avisos ou erros de qualidade de código não resolvidos sendo mesclados.
   • Defina "Todos" para bloquear solicitações de pull que tenham qualquer resultado de qualidade de código não resolvido ao serem mescladas.
7. Quando terminar de definir ou editar o conjunto de regras, clique em Criar ou Salvar alterações.

Próximas etapas

Saiba como GitHub Code Quality funciona em solicitações de pull para impedir que problemas de qualidade de código cheguem à sua ramificação padrão. Confira Corrigindo problemas de qualidade do código antes de mesclar sua solicitação de pull.