Gerenciar conjuntos de regras para um repositório

Você pode editar, monitorar e excluir conjuntos de regras existentes em um repositório para alterar como as pessoas podem interagir com branches e tags específicas.

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.

Rulesets are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see "GitHub’s plans."

Push rulesets are available for the GitHub Team plan in internal and private repositories, and forks of repositories that have push rulesets enabled.

Neste artigo

Depois de criar um conjunto de regras, é possível fazer alterações nele. Por exemplo, você pode adicionar regras para proteger melhor seus branches ou tags, ou pode desabilitar temporariamente um conjunto de regras para solucionar quaisquer efeitos não intencionais na experiência do colaborador para seu repositório.

Use as APIs REST e GraphQL para gerenciar conjuntos de regras. Para obter mais informações, confira "Pontos de extremidade da API REST para regras" e "Mutações."

Exibir conjuntos de regras para um repositório

Na página "Conjuntos de regras", qualquer pessoa com acesso de leitura ao repositório pode visualizar os conjuntos de regras ativos direcionados a uma determinada restrição de branch, tag ou push de .

Para conjuntos de regras por push para repositórios bifurcados, a página "Conjuntos de regras" indicará que o conjunto de regras é gerenciado pelo repositório de origem onde a regra é aplicada.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Na exibição da árvore de arquivos à esquerda, selecione o menu suspenso do branch e clique em Exibir todos os branches. Você também pode encontrar o menu suspenso do branch na parte superior do editor de arquivos integrado.

    Captura de tela do modo de exibição de árvore de arquivos de um repositório. Há um menu suspenso para branches expandido e realçado em laranja escuro.

  3. À esquerda do nome do branch, clique em .

  4. Opcionalmente, para filtrar os resultados, clique nas guias ou use a barra de pesquisa "Pesquisar branches".

  5. Clique no nome do conjunto de regras que deseja ver.

Como editar um conjunto de regras

Você pode editar um conjunto de regras para alterar partes do conjunto de regras, como o nome, ignorar permissões ou regras. Você também pode editar um conjunto de regras para alterar o status dele, por exemplo, se desejar habilitar ou desabilitar temporariamente um conjunto de regras.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Configurações. 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. Na página "Conjuntos de regras", clique no nome do conjunto de regras que deseja editar.

  5. Altere o conjunto de regras conforme necessário. Para obter informações sobre as regras disponíveis, confira "Regras disponíveis para conjuntos de regras".

  6. Na parte inferior da página, clique em Salvar alterações.

Excluir um conjunto de regras

Dica: caso deseje desabilitar um conjunto de regras temporariamente, mas não excluí-lo, defina o status do conjunto de regras como "Desabilitado". Para obter mais informações, confira "Como editar um conjunto de regras".

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Configurações. 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 no nome do conjunto de regras que deseja excluir.

  5. À direita do nome do conjunto de regras, selecione e clique em Excluir conjunto de regras.

    Captura de tela da página usada para editar um conjunto de regras. Abaixo de um botão rotulado com três pontos, uma opção rotulada "Excluir conjunto de regras" está realçada em laranja.