Generating regular expressions for custom patterns with Copilot secret scanning

Generating a regular expression for a repository with Verificação de segredos do Copilot

1. Em GitHub, acesse 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.

   

3. Na seção "Segurança" da barra lateral, clique em Segurança de código e análise.

4. Em "Segurança e análise de código", encontre o "GitHub Advanced Security".

5. Em "Secret scanning", 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.

   Nota: 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 "Formato de segredo". Para obter mais informações, confira "Definir um padrão personalizado para um repositório" ou "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.

     

9. Clique em Mais opções para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto. O GitHub adicionará os exemplos digitados no painel deslizante ao campo Cadeia de caracteres de teste.

10. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.

11. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos.

    

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

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

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

Generating a regular expression for an organization with Verificação de segredos do Copilot

1. No canto superior direito de GitHub, selecione sua foto de perfil e selecione Suas organizações.

2. Ao lado da organização, clique em Configurações.

3. In the "Security" section of the sidebar, click Code security then Global settings.

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

   Nota: 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 "Formato de segredo". Para obter mais informações, confira "Definir um padrão personalizado para um repositório" ou "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.

     

8. Clique em Mais opções para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto. O GitHub adicionará os exemplos digitados no painel deslizante ao campo Cadeia de caracteres de teste.

9. When you're ready to test your new custom pattern, to identify matches in selected repositories without creating alerts, click Save and dry run.

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

    • Para realizar a simulação em toda a organização, selecione Todos os repositórios da 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.

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

12. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos.

    

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

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

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

Further reading

• "Responsible generation of regular expressions with Copilot secret scanning"