Definir proteção contra mesclagem de verificação de código

Proteja sua base de código bloqueando solicitações de pull que falham verificações de code scanning.

Quem pode usar esse recurso?

Proprietários da organização, gerentes de segurança e membros da organização com a função de administrador

O Code scanning está disponível para os seguintes tipos de repositório:

  • Repositórios públicos no GitHub.com
  • Repositórios de propriedade da organização em GitHub Team, GitHub Enterprise Cloudou GitHub Enterprise Server, com GitHub Code Security habilitados.

Neste artigo

Criar um conjunto de regras de proteção contra mesclagem para um repositório

  1. Em GitHub, acesse a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, em "Código e automação", clique em Regras e em Conjuntos de regras.

    Captura de tela da barra lateral da página "Configurações" de um repositório. O submenu "Regras" está expandido, e a opção "Conjuntos de regras" está realçada em laranja.

  4. Clique em Novo conjunto de regras.

  5. Para criar um conjunto de regras direcionado a branches, clique em Novo conjunto de regras de branch.

  6. Em "Nome do conjunto de regras", digite um nome para o conjunto de regras.

  7. Opcionalmente, para alterar o status de imposição padrão, clique em Disabled e selecione um status de imposição.

  8. Em "Proteções de ramificação", selecione Exigir resultados do code scanning.

  9. Em "Required tools and alert thresholds", clique em Add tool e selecione uma ferramenta de code scanning com o menu suspenso. Por exemplo, "CodeQL".

  10. Ao lado do nome de uma ferramenta do code scanning:

    • Clique em Alertas e selecione um dos seguintes: Nenhum, Erros, Erros e Avisos ou Todos.
    • Clique em Alertas de segurança e selecione um dos seguintes: Nenhum, Crítico, Alto ou superior, Médio ou superior ou Todos.

    Captura de tela da seção "Ferramentas necessárias e limites de alerta" das configurações de "Conjuntos de regras".

Para obter mais informações sobre a gravidade do alerta e os níveis de severidade de segurança, consulte Sobre alertas de digitalização de códigos.

Para obter mais informações sobre como gerenciar conjuntos de regras em um repositório, confira Como gerenciar conjuntos de regras de um repositório.

Criar um conjunto de regras de proteção contra mesclagem com a API REST

Você pode usar a API REST para criar um conjunto de regras com a regra code_scanning, que permite definir ferramentas específicas e definir limites de alerta. Para saber mais, confira Pontos de extremidade da API REST para regras.