Gerenciar conjuntos de regras para um repositório

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

Você pode usar as APIs REST e GraphQL para gerenciar conjuntos de regras. Para saber mais, 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 um determinado branch, tag ou restrição de envio.

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. Em GitHub, acesse 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 View all branches. Você também pode encontrar o menu suspenso do branch na parte superior do editor de arquivos integrado.

   

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

   Dica

   Somente ramificações que têm um conjunto de regras têm um ícone ao lado do nome.

4. Opcionalmente, para filtrar os resultados, clique nas guias ou use a barra "Pesquisar ramificações".

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

Você também pode ver conjuntos de regras ativos:

• Adicionando o slug /rules à URL do repositório. Por exemplo, para exibir as regras do repositório de documentação do código aberto em GitHub, acesse https://github.com/github/docs/rules.

• Na caixa de mesclagem, caso existam regras que impeçam a mesclagem de uma solicitação de pull.

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

   

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

   

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

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.

   

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

   

4. Clique no nome do conjunto de regras que deseja excluir.

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

   

Importar um conjunto de regras

Você pode importar um conjunto de regras existente 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.

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.

   

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

   

4. Selecione a lista suspensa Novo conjunto de regras e clique em Importar um conjunto de regras.

   

5. Abra o arquivo JSON exportado.

6. Revise o conjunto de regras importado e clique em Criar.

Exibir insights de conjuntos de regras

Você pode visualizar os insights para conjuntos de regras para ver como os conjuntos de regras estão afetando um repositório. Na página "Insights de Regra", você verá uma linha do tempo das seguintes ações de usuário. Use filtros para encontrar o que está procurando.

• Ações que foram verificadas em relação a um ou mais conjuntos de regras e foram aprovadas.
• Ações que foram verificadas em relação a um ou mais conjuntos de regras e falharam.
• Ações em que alguém ignorou um ou mais conjuntos de regras.

Se um conjunto de regras estiver em execução no modo "Avaliar", você poderá ver as ações que teriam sido aprovadas ou não se o conjunto de regras estivesse ativo.

Além disso, esses insights estão disponíveis por meio da API REST dos conjuntos de regras.

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.

   

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

   

4. Na página "Insights de Regras", use os menus suspensos na parte superior da página para filtrar as ações por conjunto de regras, branch, ator e período.

5. Para ver as regras específicas que foram reprovadas ou que exigiram um bypass, clique em e expanda o nome do conjunto de regras.

   

Painel de análises de regras

O painel de insights de regras fornece um resumo visual de alto nível da atividade de avaliação de regra para seu repositório, incluindo:

•         **Sucessos, falhas e bypasses ao longo do tempo**: um gráfico mostrando tendências nos resultados da avaliação de regras, ajudando você a detectar picos em pushes bloqueados ou padrões incomuns.
  

•         **Principais contornadores**: uma lista dos contornadores mais ativos dos seus conjuntos de regras.
  

Cada gráfico leva de volta à página de insights de regra com filtros pré-preenchidos, permitindo que você analise rapidamente status específicos, bypassers ou intervalos de tempo.

Para exibir o painel:

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.

   

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

4. Na parte superior da página "Rule Insights", exiba os gráficos de dashboard para obter uma visão geral da atividade de avaliação de regra.