Gerando expressões regulares para padrões personalizados com IA

Você pode usar o gerador de expressões regulares com tecnologia de IA para escrever expressões regulares para padrões personalizados. O gerador usa um modelo de IA para gerar expressões que correspondem à sua entrada e, opcionalmente, exemplos de cadeias de caracteres.

Quem pode usar esse recurso?

Proprietários de repositórios, proprietários de organizações, gerentes de segurança e usuários com a função de administrador

Neste artigo

Gerando uma expressão regular para um repositório com IA

Observação

Você não precisa de uma assinatura do GitHub Copilot para usar o gerador de expressões regulares com IA. Segredos detectados por IA os recursos estão disponíveis para repositórios pertencentes a organizações e empresas com GitHub Secret Protection habilitado.

  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 seção "Security" da barra lateral, clique em Advanced Security.

  4. Em "Secret Protection", em "Padrões personalizados", clique em Novo padrão.

  5. No campo "Nome do padrão", digite um nome para o seu padrão.

  6. No canto superior direito, clique em Gerar com IA.

    Observação

    Você pode inserir uma expressão regular manualmente em vez de usar o gerador, digitando uma expressão regular no formato do seu padrão de segredo, no campo "Secret format". Para obter mais informações, confira Como definir um padrão personalizado para um repositório ou Como definir um padrão personalizado para uma organização.

  7. No painel deslizante exibido:

    • Preencha o campo "Eu quero uma expressão regular que", descrevendo, de preferência em inglês simples, quais padrões você deseja que sua expressão regular capture. Você pode usar outras linguagens naturais, mas o desempenho pode não ser tão bom quanto com o inglês.

    • Preencha o campo "Exemplos do que estou procurando", dando um exemplo de um padrão que você deseja verificar.

    • Clique em Gerar sugestões.

    • Se desejar, clique em uma sugestão para exibir uma descrição da expressão regular.

    • Clique em Usar resultados na seção Resultados que aparece, para o resultado que você deseja usar.

      Captura de tela de um formulário preenchido de padrão personalizado do secret scanning para o gerador usar.

  8. Você pode clicar em Mais opções para especificar outro conteúdo ao redor ou critérios adicionais de correspondência para o formato do segredo. GitHub adicionará os exemplos que você digitou no painel lateral ao campo string de teste.

  9. Quando estiver pronto para testar seu novo padrão personalizado, a fim de identificar correspondências no repositório sem criar alertas, clique em Salvar e executar uma simulação.

  10. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos. Captura de tela mostrando os resultados da simulação.

  11. Edite o novo padrão personalizado para corrigir problemas com os resultados e testar suas alterações e clique em Salvar e executar uma simulação.

  12. Quando estiver satisfeito com o novo padrão personalizado, clique em Publicar padrão.

Você pode configurar secret scanning para verificar pushes em busca de padrões personalizados antes que os commits sejam mesclados na branch padrão. Para obter mais informações, confira Habilitar a proteção por push para um padrão personalizado.

Gerando uma expressão regular para uma organização com IA

  1. No canto superior direito de GitHub, clique na foto de perfil e clique em Your organizations.

  2. Selecione uma organização clicando nela.

  3. No nome da organização, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela das guias no perfil de uma organização. A guia "Configurações" está contornada em laranja escuro.

  4. Na seção "Security" da barra lateral, clique em Advanced Security e, em seguida, em Global settings.

  5. Em "Padrões personalizados", clique em Novo padrão.

  6. No campo "Nome do padrão", digite um nome para o seu padrão.

  7. No canto superior direito, clique em Gerar com IA.

    Observação

    Você pode inserir uma expressão regular manualmente em vez de usar o gerador, digitando uma expressão regular no formato do seu padrão de segredo, no campo "Secret format". Para obter mais informações, confira Como definir um padrão personalizado para um repositório ou Como definir um padrão personalizado para uma organização.

  8. No painel deslizante exibido:

    • Preencha o campo "Eu quero uma expressão regular que", descrevendo, de preferência em inglês simples, quais padrões você deseja que sua expressão regular capture. Você pode usar outras linguagens naturais, mas o desempenho pode não ser tão bom quanto com o inglês.

    • Preencha o campo "Exemplos do que estou procurando", dando um exemplo de um padrão que você deseja verificar.

    • Clique em Gerar sugestões.

    • Se desejar, clique em uma sugestão para exibir uma descrição da expressão regular.

    • Clique em Usar resultados na seção Resultados que aparece, para o resultado que você deseja usar.

      Captura de tela de um formulário preenchido de padrão personalizado do secret scanning para o gerador usar.

  9. Você pode clicar em Mais opções para especificar outro conteúdo ao redor ou critérios adicionais de correspondência para o formato do segredo. GitHub adicionará os exemplos que você digitou no painel lateral ao campo string de teste.

  10. Se estiver pronto para testar seu novo padrão personalizado para identificar correspondências em repositórios específicos sem criar alertas, clique em Salvar e executar uma simulação.

  11. Selecione os repositórios em que deseja realizar a simulação.

    • Para executar a simulação em toda a organização, selecione Todos os repositórios na organização.
    • Para especificar os repositórios nos quais você deseja realizar a simulação, selecione Repositórios selecionados, pesquise e selecione até dez repositórios.

  12. Quando tudo estiver pronto para testar seu novo padrão personalizado, clique em Executar.

  13. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos. Captura de tela mostrando os resultados da simulação.

  14. Edite o novo padrão personalizado para corrigir problemas com os resultados e testar suas alterações e clique em Salvar e executar uma simulação.

  15. Quando estiver satisfeito com o novo padrão personalizado, clique em Publicar padrão.

Você pode configurar secret scanning para verificar pushes em busca de padrões personalizados antes que os commits sejam mesclados na branch padrão. Para obter mais informações, confira Habilitar a proteção por push para um padrão personalizado.

Leitura adicional