Skip to main content

Criar conjuntos de regras para um repositório

Você pode adicionar conjuntos de regras a um repositório para controlar como as pessoas podem interagir com tags e branches específicos.

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 e ver os insights do conjunto de regras. Para obter mais informações, confira "Sobre as funções personalizadas do 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".

Introdução

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 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 sobre conjuntos de regras, confira "Sobre os conjuntos de regras".

Para importar um dos conjuntos de regras pré-criados por GitHub, consulte github/ruleset-recipes.

Você pode importar um conjunto de regras de outro repositório ou organização usando um arquivo JSON. Isso pode ser útil se você quiser aplicar o mesmo conjunto de regras a vários repositórios ou organizações. Para obter mais informações, consulte "Como gerenciar conjuntos de regras para repositórios na sua organização".

Você também pode criar conjuntos de regras para todos os repositórios em uma organização. Para obter mais informações, confira "Criar conjuntos de regras para repositórios na sua organização".

Para criar um conjunto de regras, conclua os procedimentos a seguir:

Sobre o uso de status de imposição

Ao criar ou editar seu conjunto de regras, você pode usar status de imposição para configurar como seu conjunto de regras será imposto.

Usar o modo "Avaliar" é uma ótima opção para testar seu conjunto de regras sem impô-lo. Você pode usar a página "Insights da regra" para ver se a ação teria violado a regra. Para obter mais informações, confira "Gerenciar conjuntos de regras para um repositório".

Você pode selecionar qualquer um dos seguintes status de imposição para seu conjunto de regras.

  • Ativo: seu conjunto de regras será imposto após a criação.
  • Avaliar: seu conjunto de regras não será aplicado, mas você poderá monitorar quais ações violariam ou não as regras na página "Insights de regras".
  • Desabilitado: seu conjunto de regras não será imposto ou avaliado.

Criar um conjunto de regras de branch ou tag

  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. Você pode criar um conjunto de regras direcionado a branches ou a tags.

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

    • Para criar um conjunto de regras direcionado a tags, selecione e clique em Novo conjunto de regras de tag.

      Captura de tela da página "Conjuntos de regras". Ao lado do botão "Novo conjunto de regras de branch", um menu suspenso está expandido, com uma opção rotulada "Novo conjunto de regras de tag" realçada em laranja.

  5. Na seção "Geral", digite um nome para o conjunto de regras, selecione Desabilitado e selecione um status de imposição.

Conceder permissões de bypass para seu conjunto de regras

Você pode conceder permissões de ignorar determinadas funções, equipes ou aplicativos para seu conjunto de regras. Os seguintes itens são qualificados para acesso de bypass:

  • Administradores de repositório ou proprietários de organizações
  • A função de manutenção ou gravação ou funções de repositório personalizadas com base na função de gravação
  • Teams
  • GitHub Apps
  • Dependabot. Para obter mais informações sobre o Dependabot, confira "Guia de início rápido do Dependabot".
  1. Para conceder permissões de bypass para o conjunto de regras, na seção "Lista de bypass", clique em e depois clique em Somente para solicitações de pull.

    O ator selecionado agora é obrigado a abrir uma solicitação de pull para fazer alterações em um repositório, criando uma trilha digital clara com suas alterações. O ator pode então optar por ignorar quaisquer proteções de branch e mesclar essa solicitação de pull.

Escolher quais branches ou tags direcionar

Para direcionar branches ou tags na seção "Branches de destino" ou "Tags de destino", selecione Adicionar um destino e escolha como deseja incluir ou excluir branches ou tags. Use a sintaxe fnmatch para incluir ou excluir branches ou tags com base em um padrão. Para obter mais informações, confira "Como usar a sintaxe fnmatch".

Você pode adicionar vários critérios de direcionamento ao mesmo conjunto de regras. Por exemplo, você pode incluir o branch padrão, incluir os branches que correspondam ao padrão *feature* e excluir especificamente um branch que corresponda ao padrão not-a-feature.

Selecionar proteções de branch ou tag

Na seção "Proteções de branch" ou "Proteções de tag", selecione as regras que deseja incluir no conjunto de regras. Ao selecionar uma regra, você poderá inserir configurações adicionais para ela. Para obter mais informações sobre as regras, confira "Regras disponíveis para conjuntos de regras".

Observações: se você selecionar Exigir verificações de status antes da mesclagem, na seção "Configurações adicionais":

  • Você poderá inserir o nome de cada verificação de status que deseja exigir. Para terminar de adicionar a verificação de status como um requisito, você deve clicar em .
  • Se você selecionar Exigir que branches sejam atualizados antes da mesclagem, deverá definir uma verificação para que a proteção entre em vigor.

Adicionar restrições de metadados

Observações:

  • A adição de restrições de metadados pode afetar a experiência das pessoas que contribuem para seu repositório. Antes de aplicar um conjunto de regras com restrições de metadados, você pode selecionar o status de imposição "Avaliar" para o conjunto de regras testar os efeitos de quaisquer restrições de metadados sem afetar os colaboradores. Para obter mais informações sobre as restrições de metadados, confira "Regras disponíveis para conjuntos de regras".
  • As restrições de metadados se destinam a aumentar a consistência entre os commits no seu repositório. Elas não se destinam a substituir medidas de segurança, como exigir uma revisão de código por meio de solicitações de pull.
  • Se você fizer uma mesclagem squash para uma ramificação, os commits nessa ramificação devem atender a todos os requisitos de metadados para a ramificação base.
  1. Opcionalmente, na seção "Restrições de metadados", para adicionar uma regra para controlar os metadados de commits que estão sendo enviados por push para o branch ou a tag, clique em .

    Captura de tela da seção "Restrição de metadados". À direita do cabeçalho, um ícone de adição está realçado com um contorno laranja.

  2. Defina as configurações para a regra de restrição de metadados e clique em Adicionar. Você pode adicionar várias restrições ao mesmo conjunto de regras.

    Para a maioria dos requisitos, como "Precisa começar com um padrão correspondente", o padrão inserido é interpretado literalmente e não há suporte para curingas. Por exemplo, o caractere * representa apenas o caractere literal *.

    Para padrões mais complexos, você pode selecionar "Precisa corresponder a determinado padrão regex" ou "Não precisa corresponder a determinado padrão regex" e usar a sintaxe de expressão regular para definir o padrão correspondente. Para obter mais informações, confira "Como usar expressões regulares para metadados de commit".

    Qualquer pessoa que visualizar os conjuntos de regras de um repositório poderá ver a descrição fornecida por você.

Finalizar seu conjunto de regras e próximas etapas

Para concluir a criação do conjunto de regras, clique em Criar. Se o status de imposição do conjunto de regras for definido como "Ativo", o conjunto de regras entrará em vigor imediatamente.

Você pode exibir insights para o conjunto de regras para ver como as regras estão afetando seus colaboradores. Se o status de imposição estiver definido como "Avaliar", você poderá ver quais ações teriam passado ou falhado se o conjunto de regras estivesse ativo. Para obter mais informações sobre insights para conjuntos de regras, confira "Gerenciar conjuntos de regras para um repositório".

Usar a sintaxe fnmatch

Use a sintaxe fnmatch para definir padrões direcionados aos nomes de branches, tags e repositórios ao criar um conjunto de regras.

Use o curinga * para encontrar a correspondência de qualquer cadeia de caracteres. Como o GitHub usa o sinalizador File::FNM_PATHNAME para a sintaxe File.fnmatch, o curinga * não corresponde aos separadores de diretório (/). Por exemplo, qa/* corresponderá a todos os branches que começam com qa/ e que contêm uma barra "/", mas não corresponderá a qa/foo/bar. Você pode incluir qualquer quantidade de barras "/" após qa com qa/**/*, o que corresponderá, por exemplo, a qa/foo/bar/foobar/hello-world. Você também pode estender a cadeia de caracteres qa com qa**/**/* para tornar a regra mais inclusiva.

Para obter mais informações sobre as opções de sintaxe, confira a documentação de fnmatch.

Observação: nem todas as expressões da sintaxe fnmatch são compatíveis com as regras de proteção de ramificação. Esteja ciente das seguintes restrições:

  • Não é possível usar a barra invertida (\) como um caractere de citação, pois o GitHub não é compatível com o uso de barras invertidas nas regras de proteção de ramificação.
  • Você pode especificar conjuntos de caracteres entre colchetes ([]), mas atualmente não pode complementar um conjunto com o operador ^ (por exemplo, [^charset]).
  • Embora o GitHub seja compatível com File::FNM_PATHNAME na sintaxe fnmatch, File::FNM_EXTGLOB não é compatível.

Usar expressões regulares para metadados de commit

Ao adicionar restrições de metadados, use a sintaxe de expressão regular para definir a quais padrões os metadados relevantes, como a mensagem do commit ou o nome do branch ou da tag, precisam ou não corresponder.

Os conjuntos de regras dão suporte à sintaxe RE2. Para obter mais informações, confira o guia de sintaxe do Google. Para validar as expressões, use o validador em regex101.com selecionando a variante "Golang" na barra lateral esquerda.

Por padrão, expressões regulares em restrições de metadados não consideram várias linhas de texto. Por exemplo, se você tiver uma mensagem do commit de várias linhas, o padrão ^ABC será uma correspondência se qualquer linha da mensagem começar com ABC. Para corresponder a várias linhas da mensagem, comece sua expressão com (?m).

Não há suporte para a declaração lookahead negativa, indicada como ?!. No entanto, para os casos em que você precisa procurar determinada cadeia de caracteres que não é seguida de outra cadeia de caracteres especificada, use a asserção lookahead positiva, indicada como ?, combinada com o requisito "Não deve corresponder a determinado padrão regex".

Observação: se você precisar que os colaboradores assinem commits, isso poderá interferir nos padrões de expressão regular. Quando alguém sai do serviço, o GitHub adiciona uma cadeia de caracteres como Signed-off-by: #AUTHOR-NAME <#AUTHOR-EMAIL> à mensagem de commit. Para obter mais informações, confira "Como gerenciar a política de aprovação de confirmação para sua organização".

Padrões úteis de expressão regular

Os exemplos a seguir fornecem padrões úteis para metadados de commit. Para usar esses padrões, defina Requisito como "Precisa corresponder a um determinado padrão de regex".

Garantir que os nomes de branches sejam compatíveis com o Windows

Use o padrão a seguir para garantir que os nomes dos branches incluam apenas números, letras minúsculas e os caracteres - e _. Isso garante que os nomes dos branches sejam compatíveis com sistemas operacionais que não usam sistemas de arquivos que diferenciam maiúsculas de minúsculas por padrão.

Text
\A[0-9a-z-_]$

Corresponde a: my-branch

Não corresponde: myBranch

Garantir que os nomes de tags usem um controle de versão semântico

Use o padrão a seguir para garantir que os nomes das tags estejam em conformidade com o controle de versão semântico. Para obter mais informações, confira a documentação em semver.org.

Text
^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Corresponde a: 1.2.3, 10.20.30 e 1.1.2-prerelease+meta

Não corresponde: 1.2, 1.2-SNAPSHOT

Limitar o comprimento das linhas em mensagens de commit

O livro Pro Git recomenda limitar a primeira linha de uma mensagem de commit a cerca de 50 caracteres.

Use o padrão a seguir para garantir que a primeira linha em uma mensagem de commit contenha 50 caracteres ou menos.

Text
\A.{1,50}$
Garantir que as mensagens do commit comecem com uma resolução e um número de problema

Use o padrão a seguir para garantir que as mensagens de commit contenham a palavra Resolves: ou Fixes:, seguido de uma cadeia de caracteres como #1234.

Text
^(Resolves|Fixes): \#[0-9]+$

Corresponde a: Fixes: #1234

Não corresponde: Add conditional logic to foo.bar

Impor commits convencionais

Use o padrão a seguir para garantir que as mensagens de commit estejam em conformidade com a especificação Commits Convencionais. Para obter mais informações, confira conventionalcommits.org.

Text
^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)

Corresponde a: feat: allow provided config object to extend other configs

Não corresponde: Add conditional logic to foo.bar