60b71c4e24
Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Courtney Claessens <courtneycl@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Steve Guntrip <stevecat@github.com> Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Melissa Xie <mxie@users.noreply.github.com> Co-authored-by: Andy Feller <andyfeller@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Kelly Arwine <kellyarwine@github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: Max Schaefer <54907921+max-schaefer@users.noreply.github.com> Co-authored-by: Tiferet Gazit <tiferet@github.com> Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com> Co-authored-by: Andrew Eisenberg <aeisenberg@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Annelisa Stephan <meowius@github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: isaacmbrown <isaacmbrown@github.com> Co-authored-by: Greg Padak <gpadak@github.com>
52 lines
3.1 KiB
Markdown
52 lines
3.1 KiB
Markdown
---
|
|
title: Generating regular expressions for custom patterns with AI
|
|
shortTitle: Use the regular expression generator
|
|
intro: 'You can use the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} to generate regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.'
|
|
product: '{% data reusables.gated-features.secret-scanning %}'
|
|
versions:
|
|
feature: secret-scanning-custom-pattern-ai-generated
|
|
type: how_to
|
|
topics:
|
|
- Advanced Security
|
|
- Secret scanning
|
|
- AI
|
|
---
|
|
{% data reusables.secret-scanning.beta-custom-pattern-regular-expression-generator %}
|
|
|
|
## About the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %}
|
|
|
|
Custom patterns are formatted as regular expressions. You can manually type in a regular expression on {% data variables.product.prodname_dotcom %}, or you can use the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %}. {% data reusables.secret-scanning.regular-expression-generator-overview %}
|
|
|
|
For instructions on how to generate a regular expression manually for your repository or organization, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."
|
|
|
|
For more information about the generator, see "[AUTOTITLE](/code-security/secret-scanning/about-the-regular-expression-generator-for-custom-patterns)."
|
|
|
|
## Generating a regular expression for a repository using the generator
|
|
|
|
{% data reusables.repositories.navigate-to-repo %}
|
|
{% data reusables.repositories.sidebar-settings %}
|
|
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
|
|
{% data reusables.repositories.navigate-to-ghas-settings %}
|
|
{% data reusables.advanced-security.secret-scanning-new-custom-pattern %}
|
|
{% data reusables.advanced-security.secret-scanning-generate-regular-expression-custom-pattern %}
|
|
1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click **Save and dry run**.
|
|
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
|
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
|
|
|
{% data reusables.secret-scanning.link-to-push-protection %}
|
|
|
|
## Generating a regular expression for an organization using the generator
|
|
|
|
{% data reusables.profile.access_org %}
|
|
{% data reusables.profile.org_settings %}
|
|
{% data reusables.organizations.security-and-analysis %}
|
|
{% data reusables.repositories.navigate-to-ghas-settings %}
|
|
{% data reusables.advanced-security.secret-scanning-new-custom-pattern %}
|
|
{% data reusables.advanced-security.secret-scanning-generate-regular-expression-custom-pattern %}
|
|
1. When you're ready to test your new custom pattern, to identify matches in selected repositories without creating alerts, click **Save and dry run**.
|
|
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
|
|
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
|
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
|
|
|
{% data reusables.secret-scanning.link-to-push-protection %}
|