Skip to main content

Regras disponíveis para conjuntos de regras

Saiba quais regras você pode adicionar a um conjunto de regras para proteger tags e branches específicos em um repositório.

Quem pode usar esse recurso

Qualquer pessoa com acesso de leitura em um repositório pode ver os conjuntos de regras do repositório. As pessoas com acesso de administrador em um repositório ou uma função personalizada com a permissão "editar regras de repositório", podem criar, editar e excluir conjuntos de regras de um repositório.

Os conjuntos de regras estão disponíveis em repositórios públicos com o GitHub Free e o GitHub Free para organizações e em repositórios públicos e privados com o GitHub Pro, o GitHub Team e o GitHub Enterprise Cloud. Para mais informações, confira "Planos do GitHub".

Você pode criar conjuntos de regras para controlar como os usuários podem interagir com as tags e os branches selecionados em um repositório. Ao criar um conjunto de regras, você pode optar por habilitar ou desabilitar as regras descritas nas seções a seguir.

Ao criar um conjunto de regras, você pode permitir que alguns usuários ignorem as regras do conjunto de regras. Podem ser usuários com certas permissões, equipes específicas ou GitHub Apps. Para obter mais informações, confira "Sobre os conjuntos de regras".

Para obter mais informações sobre como criar conjuntos de regras, confira "Criar conjuntos de regras para um repositório".

Restringir as criações

Se isso estiver selecionado, somente os usuários com permissões de bypass poderão criar branches ou tags cujos nomes correspondam ao padrão especificado.

Restringir as atualizações

Se isso estiver selecionado, somente os usuários com permissões de bypass poderão enviar por push para branches ou tags cujos nomes correspondam ao padrão especificado.

Restringir as exclusões

Se isso estiver selecionado, somente os usuários com permissões de bypass poderão excluir branches ou tags cujos nomes correspondam ao padrão especificado. Essa regra está selecionada por padrão.

Exigir histórico linear

A imposição de um histórico de commits linear impede que os colaboradores efetuem push de commits de mesclagem em tags e branches direcionados. Isto significa que qualquer solicitação de pull mesclada no branch ou na tag precisa usar uma mesclagem squash ou uma mesclagem de troca de base. Um histórico de commit estritamente linear pode ajudar as equipes a reverter alterações mais facilmente. Para obter mais informações sobre métodos de mesclagem, confira "Sobre merges de pull request".

Antes de exigir um histórico de commit linear, seu repositório deve permitir merge squash ou merge rebase. Para obter mais informações, confira "Configurar merges de pull request".

Exigir que as implantações tenham êxito antes da mesclagem

Você pode exigir que as alterações sejam implantadas com sucesso em ambientes específicos antes que um branch possa ser mesclado. Por exemplo, você pode usar essa regra para garantir que as alterações sejam implantadas com sucesso em um ambiente de preparo antes que as alterações sejam mescladas com o branch padrão.

Exigir commits assinados

Quando você habilitar a assinatura de commit obrigatória em um branch, os colaboradores e os bots só poderão efetuar push de commits que foram assinados e verificados no branch. Para obter mais informações, confira "Sobre a verificação de assinatura de commit".

Observações:

  • Se você habilitar o modo vigilante nas configurações da conta, o que indica que os commits serão sempre assinados, todos os commits que o GitHub identificar como "Parcialmente verificados" serão permitidos em branches que exijam commits assinados. Para obter mais informações sobre o modo vigilante, confira "Exibindo status de verificação para todos os seus commits".
  • Se um colaborador fizer push de um commit não assinado para um branch que exige assinaturas de commit, o colaborador deverá fazer rebase do commit para incluir uma assinatura verificada e, em seguida, fazer push forçado no commit reescrito para o branch.

Você sempre pode fazer push de commits locais para o branch se os commits forem assinados e verificados. Você também pode mesclar commits assinados e verificados no branch usando uma solicitação de pull no GitHub. No entanto, você não pode mesclar por squash nem mesclar uma solicitação de pull no branch no GitHub, a menos que seja o autor da solicitação de pull. Você pode mesclar por squash e mesclar as solicitações de pull localmente. Para obter mais informações, confira "Fazer checkout de pull requests no local".

Para obter mais informações sobre métodos de mesclagem, confira "Sobre métodos de merge no GitHub".

Exigir uma solicitação de pull antes da mesclagem

Você pode exigir que todas as alterações no branch de destino sejam associadas a uma solicitação de pull. A solicitação de pull não precisa necessariamente ser aprovada, mas precisa ser aberta.

Configurações adicionais

Observação: se você selecionar Ignorar aprovações de solicitações de pull obsoletas quando novos commits forem enviados por push e/ou Exigir aprovação do push revisável mais recente, a criação manual do commit de mesclagem de uma solicitação de pull e a execução direta dele em um branch protegido falhará, a menos que o conteúdo da mesclagem corresponda exatamente à mesclagem gerada por GitHub para a solicitação de pull.

Além disso, com essas configurações, a aprovação de revisões será ignorada como obsoleta se a base de mesclagem introduzir novas alterações depois que a revisão for enviada. A base de mesclagem é o commit que é o último ancestral comum entre o branch do tópico e o branch base. Se a base de mesclagem for alterada, a solicitação de pull não poderá ser mesclada até que alguém aprove o trabalho novamente.

Os administradores do repositório ou funções personalizadas com a permissão "editar regras do repositório" podem exigir que todas as solicitações de pull recebam um número específico de revisões de aprovação antes que alguém mescle a solicitação de pull em um branch protegido. Você pode exigir a aprovação de revisões de pessoas com permissões de gravação no repositório ou de um proprietário de código designado.

Se você habilitar as revisões obrigatórias, os colaboradores só poderão efetuar push das alterações em um branch por meio de uma solicitação de pull aprovada pelo número obrigatório de revisores com permissões de gravação.

Se alguém escolher a opção Solicitar alterações em uma revisão, ela precisará aprovar a solicitação de pull para que a solicitação de pull possa ser mesclada. Se um revisor que solicita alterações em um pull request não estiver disponível, qualquer pessoa com permissões de gravação no repositório poderá ignorar a revisão de bloqueio.

Mesmo depois de todos os revisores necessários terem aprovado um pull request, os colaboradores não poderão fazer o merge do pull request se houver outros pull requests abertos que tenham um branch de cabeçalho apontando para o mesmo commit com revisões pendentes ou rejeitadas. Alguém com permissões de gravação deve aprovar ou ignorar a revisão de bloqueio nos outros pull requests primeiro.

Opcionalmente, você pode optar por ignorar as aprovações obsoletas de solicitação de pull quando é efetuado o push de commits que afetam a comparação na solicitação de pull. O GitHub registra o estado da comparação no ponto em que uma solicitação de pull é aprovada. Esse estado representa o conjunto de alterações que o revisor aprovou. Se a comparação mudar desse estado (por exemplo, porque um colaborador efetua push de novas alterações para o branch de solicitação de pull ou clica em Atualizar branch ou porque uma solicitação de pull relacionada foi mesclada no branch de destino), a revisão de aprovação será descartada como obsoleta e a solicitação de pull não poderá ser mesclada até que alguém aprove o trabalho novamente. Para obter informações sobre o branch de destino, confira "Sobre solicitação de pull".

Opcionalmente, você pode optar por exigir análises dos proprietários do código. Se você fizer isso, qualquer solicitação de pull que modifica o conteúdo com um proprietário do código precisará ser aprovada pelo proprietário desse código para que a solicitação de pull possa ser mesclada no branch protegido.

Opcionalmente, você pode exigir uma aprovação de alguém que não seja a última pessoa a efetuar push para um branch para que uma solicitação de pull possa ser mesclada. Isso significa que, pelo menos, outro revisor autorizado aprovou alguma alteração. Por exemplo, o "último revisor" pode verificar se o conjunto mais recente de alterações incorpora os comentários de outras revisões e não adiciona um conteúdo novo e não revisado.

Para solicitações de pull complexas que exigem muitas revisões, exigir uma aprovação de alguém que não seja a última pessoa a efetuar o push pode ser um meio-termo que evita a necessidade de ignorar todas as revisões obsoletas: com essa opção, as revisões "obsoletas" não são ignoradas e a solicitação de pull permanece aprovada desde que alguém que não seja a pessoa que fez as alterações mais recentes a aprove. Os usuários que já revisaram uma solicitação de pull podem reaprová-la após o push mais recente para atender a esse requisito. Se você tiver preocupações com o "sequestro" de solicitações de pull (em que um conteúdo não aprovado é adicionado às solicitações de pull aprovadas), será mais seguro ignorar as revisões obsoletas.

Opcionalmente, você pode exigir que todos os comentários na solicitação de pull sejam resolvidos para que ela seja mesclada em um branch. Isso garante que todos os comentários sejam resolvidos ou reconhecidos antes do merge.

Exigir a aprovação nas verificações de status antes da mesclagem

As verificações de status obrigatórias garantem a aprovação em todos os testes de CI para que os colaboradores façam alterações em uma tag ou em um branch direcionado pelo seu conjunto de regras. Para obter mais informações, consulte "Configurar branches protegidos" e "Habilitar verificações de status obrigatórias". Para obter mais informações, confira "Sobre verificações de status".

Use a API de status de commits para permitir que os serviços externos marquem os commits com um status apropriado. Para obter mais informações, confira "Status do commit" na documentação da API REST.

Após a habilitação das verificações de status obrigatórias, todas as verificações de status obrigatórias precisarão ser aprovadas para que os colaboradores possam mesclar as alterações na tag ou no branch protegido.

Qualquer pessoa ou integração com permissões de gravação em um repositório pode definir o estado de qualquer verificação de status no repositório, mas em alguns casos você só pode aceitar uma verificação de status de um GitHub App específico. Ao adicionar uma regra de verificação de status obrigatória, você pode selecionar um aplicativo como a fonte esperada de atualizações de status. O aplicativo precisa ser instalado no repositório com a permissão statuses:write, precisa ter enviado uma execução de verificação recentemente e precisa estar associado a uma verificação de status obrigatória preexistente no conjunto de regras. Se o status for definido por qualquer outra pessoa ou integração, a mesclagem não será permitida. Se você selecionar "qualquer fonte", você ainda pode verificar manualmente o autor de cada status, listado na caixa de merge.

Você pode considerar as verificações de status obrigatórias como sendo "flexíveis" ou "estritas". O tipo de verificação de status obrigatória que você escolher determinará se o branch precisará ser atualizado com o branch base antes do merge.

Tipo de verificação de status obrigatóriaConfiguraçãoRequisitos de mergeConsiderações
RigorosoA caixa de seleção Exigir a atualização dos branches antes da mesclagem está marcada.O branch do tópico precisa estar atualizado com o branch base antes da mesclagem.Este é o comportamento padrão para verificações de status obrigatórias. Podem ser necessários mais builds, pois você precisará atualizar o branch principal depois que outros colaboradores atualizarem o branch de destino.
FlexívelA caixa de seleção Exigir a atualização dos branches antes da mesclagem não está marcada.O branch não precisa estar atualizado com o branch base antes da mesclagem.Serão necessárias menos compilações, já que você não precisará atualizar o branch head depois que outros colaboradores fizerem merge de pull requests. As verificações de status poderão falhar depois que você fizer merge do branch, caso haja alterações incompatíveis com o branch base.
DesabilitadoA caixa de seleção Exigir a aprovação de verificações de status antes da mesclagem não está marcada.O branch não tem restrições de merge.Se as verificações de status obrigatórias não estiverem habilitadas, os colaboradores poderão fazer merge do branch a qualquer momento, estando ou não atualizados com o branch base. Isso aumenta a possibilidade de alterações incompatíveis.

Para obter informações sobre solução de problemas, confira "Solução de problemas de verificações de status necessárias".

Bloquear pushes forçados

Você pode impedir que os usuários forcem o push para os branches ou as tags de destino. Essa regra é habilitada por padrão.

Se alguém forçar pushes para um branch ou uma tag, os commits nos quais outros colaboradores basearam os respectivos trabalhos poderão ser removidos do histórico do branch ou da tag. Isso poderá resultar em conflitos de mesclagem ou em solicitações de pull corrompidas. O push forçado também pode ser usado para excluir branches ou apontar um branch para commits que não foram aprovados em uma solicitação de pull.

A habilitação de pushes forçados não substituirá nenhuma outra regra de proteção de branch. Por exemplo, se um branch exigir um histórico de commit linear, você não poderá forçar commits a mesclar commits para esse branch.