Skip to main content

Generating regular expressions for custom patterns with AI

You can use the AI-powered 正则表达式生成器 to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.

谁可以使用此功能?

具有管理员角色的存储库所有者、组织所有者、安全管理员和用户

Generating a regular expression for a repository with AI

注意

无需订阅 GitHub Copilot 即可使用 Copilot 机密扫描 的 正则表达式生成器。 Copilot 机密扫描 功能可用于启用了 GitHub Secret Protection 的组织和企业拥有的存储库。

  1. 在 GitHub 上,导航到存储库的主页面。

  2. 在仓库名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”。

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“Security”部分中,单击“ Advanced Security”****。

  4. Under "Secret Protection", under "Custom patterns", click New pattern.

  5. 在“模式名称”字段中,键入模式的名称。

  6. 单击右上角的“使用 AI 生成”。****。

    注意

    您可以不使用生成器,而是在“机密格式”字段中键入用于描述您的机密模式格式的正则表达式,以手动输入正则表达式。 有关详细信息,请参阅“为仓库定义自定义模式”或“为组织定义自定义模式”。

  7. 在显示的滑动面板中:

    • 填写“我想要一个这样的正则表达式”字段,最好用简单的英语描述你希望正则表达式捕获哪些模式。 可以使用其他自然语言,但性能可能不如英语。

    • 填写“我要查找的内容示例”字段,举例说明你要扫描的模式。

    • 单击“生成建议”****。

    • (可选)单击某条建议可查看该正则表达式的说明。

    • 单击显示的“结果”部分中的“使用结果”****,以获取要使用的结果。

      供生成器使用的已填写自定义 secret scanning 模式表单的截图。

  8. 可以单击“ 更多”选项 ,为机密格式提供其他周围内容或其他匹配要求。 GitHub 会将在滑动面板中键入的示例添加到 “测试字符串 ”字段。

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

  10. 试运行完成后,你将看到结果示例(最多 1000 个)。 查看结果并确定任何误报结果。 显示试运行结果的屏幕截图。

  11. 编辑新的自定义模式以修复结果的任何问题,然后测试更改,单击“保存并试运行”。

  12. 如果对新的自定义模式感到满意,请单击“发布模式”。

可以配置 secret scanning,以便在提交合并到默认分支之前检查自定义模式的推送。 有关详细信息,请参阅为自定义模式启用推送保护

Generating a regular expression for an organization with AI

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“Security”部分中,依次单击“ Advanced Security”和“Global settings”********。

  5. 在“自定义模式”下,单击“ 新建模式”。

  6. 在“模式名称”字段中,键入模式的名称。

  7. 单击右上角的“使用 AI 生成”。****。

    注意

    您可以不使用生成器,而是在“机密格式”字段中键入用于描述您的机密模式格式的正则表达式,以手动输入正则表达式。 有关详细信息,请参阅“为仓库定义自定义模式”或“为组织定义自定义模式”。

  8. 在显示的滑动面板中:

    • 填写“我想要一个这样的正则表达式”字段,最好用简单的英语描述你希望正则表达式捕获哪些模式。 可以使用其他自然语言,但性能可能不如英语。

    • 填写“我要查找的内容示例”字段,举例说明你要扫描的模式。

    • 单击“生成建议”****。

    • (可选)单击某条建议可查看该正则表达式的说明。

    • 单击显示的“结果”部分中的“使用结果”****,以获取要使用的结果。

      供生成器使用的已填写自定义 secret scanning 模式表单的截图。

  9. 可以单击“ 更多”选项 ,为机密格式提供其他周围内容或其他匹配要求。 GitHub 会将在滑动面板中键入的示例添加到 “测试字符串 ”字段。

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

  11. 选择要在其中执行试运行的存储库。

    • 若要在整个组织中执行试运行,请选择“组织中的所有存储库”。****
    • 若要指定要在其中执行试运行的存储库,请选择“所选存储库”,然后搜索并选择最多 10 个存储库。
  12. 准备好测试新的自定义模式后,请单击“运行”。

  13. 试运行完成后,你将看到结果示例(最多 1000 个)。 查看结果并确定任何误报结果。 显示试运行结果的屏幕截图。

  14. 编辑新的自定义模式以修复结果的任何问题,然后测试更改,单击“保存并试运行”。

  15. 如果对新的自定义模式感到满意,请单击“发布模式”。

可以配置 secret scanning,以便在提交合并到默认分支之前检查自定义模式的推送。 有关详细信息,请参阅为自定义模式启用推送保护

Further reading