Skip to content

Commit 6366cf9

Browse files
authored
Merge branch 'main' into repo-sync
2 parents 3b39011 + 6cb54e7 commit 6366cf9

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,8 @@ After your pattern is created, {% data variables.product.prodname_secret_scannin
8282

8383
## Defining a custom pattern for an enterprise account
8484

85-
{% ifversion fpt or ghec or ghes %}
86-
8785
Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)."
8886

89-
{% endif %}
90-
9187
{% note %}
9288

9389
**Note:** As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive {% data variables.product.prodname_secret_scanning %} alerts.
@@ -98,12 +94,12 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
9894
{% data reusables.enterprise-accounts.policies-tab %}
9995
{% data reusables.enterprise-accounts.advanced-security-policies %}
10096
{% data reusables.enterprise-accounts.advanced-security-security-features %}
101-
1. Under "Secret scanning custom patterns", click {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %}**New pattern**{% elsif ghes = 3.2 %}**New custom pattern**{% endif %}.
97+
1. Under "Secret scanning custom patterns", click {% ifversion ghes = 3.2 %}**New custom pattern**{% else %}**New pattern**{% endif %}.
10298
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
10399

104100
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
105101

106-
{% ifversion fpt or ghes > 3.2 or ghec %}
102+
{% ifversion fpt or ghes > 3.2 or ghec or ghae %}
107103
## Editing a custom pattern
108104

109105
When you save a change to a custom pattern, this closes all the {% data variables.product.prodname_secret_scanning %} alerts that were created using the previous version of the pattern.
@@ -120,7 +116,7 @@ When you save a change to a custom pattern, this closes all the {% data variable
120116

121117
* For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above.
122118
* For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above.
123-
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
119+
{%- ifversion fpt or ghes > 3.2 or ghae %}
124120
1. To the right of the custom pattern you want to remove, click {% octicon "trash" aria-label="The trash icon" %}.
125121
1. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern.
126122
1. Click **Yes, delete this pattern**.

content/rest/reference/secret-scanning.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ miniTocMaxHeadingLevel: 3
1111

1212
{% data reusables.secret-scanning.api-beta %}
1313

14-
The {% data variables.product.prodname_secret_scanning %} API lets you retrieve and update secret scanning alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For more information on secret scanning, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)."
14+
The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %}:
15+
16+
- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation.
17+
- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below.
18+
{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %}
19+
20+
For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)."
1521

1622
{% include rest_operations_at_current_path %}

data/reusables/secret-scanning/api-beta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% ifversion ghes > 3.0 %}
1+
{% ifversion ghes > 3.0 or ghae-next %}
22

33
{% note %}
44

0 commit comments

Comments
 (0)