From 757a320b1b6be5627b41ecfeac101b8090555030 Mon Sep 17 00:00:00 2001 From: Anne-Marie <102995847+am-stead@users.noreply.github.com> Date: Wed, 6 Nov 2024 13:10:39 +0000 Subject: [PATCH] Scannability improvements to front matter for remaining secret scanning articles #16234 (#52691) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../enabling-ai-powered-generic-secret-detection.md | 2 +- ...nerating-regular-expressions-for-custom-patterns-with-ai.md | 2 +- .../secret-scanning/copilot-secret-scanning/index.md | 2 +- .../copilot-secret-scanning/responsible-ai-generic-secrets.md | 1 + .../responsible-use-ai-regex-generator.md | 2 +- .../defining-custom-patterns-for-secret-scanning.md | 3 ++- .../custom-patterns/index.md | 2 +- .../custom-patterns/managing-custom-patterns.md | 2 +- .../custom-patterns/metrics-for-custom-patterns.md | 2 +- .../enabling-secret-scanning-for-non-provider-patterns.md | 3 ++- .../non-provider-patterns/index.md | 2 +- .../working-with-push-protection-from-the-command-line.md | 2 +- .../working-with-push-protection-from-the-rest-api.md | 2 +- .../working-with-push-protection-in-the-github-ui.md | 2 +- data/reusables/gated-features/copilot-secret-scanning.md | 3 +++ .../gated-features/secret-scanning-custom-patterns.md | 3 +++ .../gated-features/secret-scanning-non-provider-patterns.md | 3 +++ data/reusables/permissions/push-protection-resolve-block.md | 1 + data/reusables/permissions/security-enterprise-enable.md | 1 + 19 files changed, 27 insertions(+), 13 deletions(-) create mode 100644 data/reusables/gated-features/copilot-secret-scanning.md create mode 100644 data/reusables/gated-features/secret-scanning-custom-patterns.md create mode 100644 data/reusables/gated-features/secret-scanning-non-provider-patterns.md create mode 100644 data/reusables/permissions/push-protection-resolve-block.md create mode 100644 data/reusables/permissions/security-enterprise-enable.md diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md b/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md index 5722404716..d9c5ced326 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md @@ -3,9 +3,9 @@ title: Enabling Copilot secret scanning's generic secret detection shortTitle: Enable generic secret detection intro: 'You can enable {% data variables.secret-scanning.generic-secret-detection %} for your repository or organization. Alerts for generic secrets, such as passwords, are displayed in a separate list on the {% data variables.product.prodname_secret_scanning %} alerts page.' allowTitleToDifferFromFilename: true +permissions: '{% data reusables.permissions.security-repo-enable %}' versions: feature: secret-scanning-ai-generic-secret-detection -product: '{% data reusables.gated-features.secret-scanning %}' type: how_to topics: - Secret scanning diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai.md b/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai.md index c4bdabd015..fa3f4072df 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai.md @@ -2,7 +2,7 @@ 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 %}' +permissions: '{% data reusables.permissions.security-repo-enable %}' versions: feature: secret-scanning-custom-pattern-ai-generated type: how_to diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/index.md b/content/code-security/secret-scanning/copilot-secret-scanning/index.md index 59f7fb7473..0faba154b8 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/index.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/index.md @@ -3,7 +3,7 @@ title: Enhance your secret detection capabilities with Copilot secret scanning shortTitle: Copilot secret scanning allowTitleToDifferFromFilename: true intro: 'Learn how {% data variables.product.prodname_secret_scanning %} uses AI to detect generic secrets in your code, and generate regular expressions for your custom patterns.' -product: '{% data reusables.gated-features.secret-scanning %}' +product: '{% data reusables.gated-features.copilot-secret-scanning %}' versions: ghec: '*' topics: diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md b/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md index a93b3f8d67..75c91875cf 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md @@ -3,6 +3,7 @@ title: Responsible detection of generic secrets with Copilot secret scanning shortTitle: Generic secret detection intro: 'Learn how {% data variables.secret-scanning.copilot-secret-scanning %} uses AI responsibly to scan and create alerts for unstructured secrets, such as passwords.' allowTitleToDifferFromFilename: true +product: '{% data reusables.gated-features.copilot-secret-scanning %}' versions: feature: secret-scanning-ai-generic-secret-detection fpt: '*' diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator.md b/content/code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator.md index a314b18dc3..8a595b4045 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator.md @@ -2,7 +2,7 @@ title: Responsible use of AI to define regular expressions shortTitle: Generate regular expressions with AI intro: 'Learn about the capabilities and limitations of the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} in helping you to define custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %}.' -product: '{% data reusables.gated-features.secret-scanning %}' +product: '{% data reusables.gated-features.copilot-secret-scanning %}' allowTitleToDifferFromFilename: true versions: feature: secret-scanning-custom-pattern-ai-generated diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md index 1b484cdd87..885f816a1d 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md @@ -2,7 +2,8 @@ title: Defining custom patterns for secret scanning shortTitle: Define custom patterns intro: 'You can define your own custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %} by generating one or more regular expressions.' -product: '{% data reusables.gated-features.secret-scanning %}' +product: '{% data reusables.gated-features.secret-scanning-custom-patterns %}' +permissions: '{% data reusables.permissions.security-enterprise-enable %}' redirect_from: - /code-security/secret-security/defining-custom-patterns-for-secret-scanning - /code-security/secret-scanning/defining-custom-patterns-for-secret-scanning diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md index d3dad9996c..57cfeccf87 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md @@ -3,7 +3,7 @@ title: Custom patterns shortTitle: Custom patterns allowTitleToDifferFromFilename: true intro: 'You can extend the capabilities of {% data variables.product.prodname_secret_scanning %} to search for your own patterns. These custom patterns can range from your service API keys to connection strings into cloud resources.' -product: '{% data reusables.gated-features.secret-scanning %}' +product: '{% data reusables.gated-features.secret-scanning-custom-patterns %}' versions: ghes: '*' ghec: '*' diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md index 77329bd0c7..32478df5a8 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md @@ -2,7 +2,7 @@ title: Managing custom patterns shortTitle: Manage custom patterns intro: 'You can view, edit, and remove custom patterns, as well as enable push protection for custom patterns.' -product: '{% data reusables.gated-features.secret-scanning %}' +permissions: '{% data reusables.permissions.security-enterprise-enable %}' versions: ghes: '*' ghec: '*' diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md index 41c5a0d2b5..fc97896815 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md @@ -2,7 +2,7 @@ title: Metrics for custom patterns shortTitle: Custom pattern metrics intro: 'You can view alert metrics for custom patterns at the repository, organization, and enterprise levels.' -product: '{% data reusables.gated-features.secret-scanning %}' +permissions: '{% data reusables.permissions.security-enterprise-enable %}' versions: feature: secret-scanning-custom-patterns-metrics type: how_to diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md index 4c06b33695..65c7abca4b 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md @@ -2,7 +2,8 @@ title: Enabling secret scanning for non-provider patterns allowTitleToDifferFromFilename: true intro: 'You can enable {% data variables.product.prodname_secret_scanning %} to detect additional potential secrets at the {% ifversion security-configurations %}repository and organization levels{% else %}repository level{% endif %}.' -product: '{% data reusables.gated-features.push-protection-for-repos %}' +permissions: '{% data reusables.permissions.security-repo-enable %}' +product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}' versions: feature: secret-scanning-non-provider-patterns type: how_to diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md index 8ee2edb916..1ae7d48df4 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md @@ -3,7 +3,7 @@ title: Non-provider patterns shortTitle: Non-provider patterns allowTitleToDifferFromFilename: true intro: '{% data variables.product.prodname_secret_scanning_caps %} can also alert you to the potential use of other types of secret in code, for example: HTTP authentication headers, connection strings, and private keys. These non-provider patterns are more difficult to detect reliably so this feature is not enabled by default.' -product: '{% data reusables.gated-features.secret-scanning %}' +product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}' versions: feature: secret-scanning-non-provider-patterns topics: diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md index 925115f2d6..ca6a4ea4e8 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md +++ b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md @@ -2,7 +2,7 @@ title: Working with push protection from the command line shortTitle: Push protection on the command line intro: 'Learn your options for unblocking your push from the command line to {% data variables.product.prodname_dotcom %} if {% data variables.product.prodname_secret_scanning %} detects a secret in your changes.' -permissions: '{% data reusables.permissions.push-protection %}' +permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: fpt: '*' ghes: '*' diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md index 6673e482d7..2a81b932b2 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md +++ b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md @@ -2,7 +2,7 @@ title: Working with push protection from the REST API shortTitle: Push protection from the REST API intro: 'Learn your options for unblocking your push to {% data variables.product.prodname_dotcom %} using the REST API if {% data variables.product.prodname_secret_scanning %} detects a secret in the content of your API request.' -product: '{% data reusables.gated-features.secret-scanning %}' +permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: feature: secret-scanning-push-protection-content-endpoints type: how_to diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md index 54ffea784c..01e1797933 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md +++ b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md @@ -2,7 +2,7 @@ title: Working with push protection in the GitHub UI shortTitle: Push protection in the GitHub UI intro: 'Learn your options for unblocking your commit when {% data variables.product.prodname_secret_scanning %} detects a secret in your changes.' -permissions: '{% data reusables.permissions.push-protection %}' +permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: fpt: '*' ghes: '*' diff --git a/data/reusables/gated-features/copilot-secret-scanning.md b/data/reusables/gated-features/copilot-secret-scanning.md new file mode 100644 index 0000000000..36d26952b8 --- /dev/null +++ b/data/reusables/gated-features/copilot-secret-scanning.md @@ -0,0 +1,3 @@ +{% data variables.secret-scanning.copilot-secret-scanning %} is available for the following repositories: + +* Public, private, and internal repositories in organizations using {% data variables.product.prodname_ghe_cloud %} with [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) enabled diff --git a/data/reusables/gated-features/secret-scanning-custom-patterns.md b/data/reusables/gated-features/secret-scanning-custom-patterns.md new file mode 100644 index 0000000000..5efb79071f --- /dev/null +++ b/data/reusables/gated-features/secret-scanning-custom-patterns.md @@ -0,0 +1,3 @@ +Custom patterns for {% data variables.product.prodname_secret_scanning %} is available for the following repositories: + +* Public, private, and internal repositories in organizations using {% data variables.product.prodname_ghe_cloud %} with [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) enabled diff --git a/data/reusables/gated-features/secret-scanning-non-provider-patterns.md b/data/reusables/gated-features/secret-scanning-non-provider-patterns.md new file mode 100644 index 0000000000..1c25ae8e09 --- /dev/null +++ b/data/reusables/gated-features/secret-scanning-non-provider-patterns.md @@ -0,0 +1,3 @@ +Scanning for non-provider patterns is available for the following repositories: + +* Public, private, and internal repositories in organizations using {% data variables.product.prodname_ghe_cloud %} with [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) enabled diff --git a/data/reusables/permissions/push-protection-resolve-block.md b/data/reusables/permissions/push-protection-resolve-block.md new file mode 100644 index 0000000000..01ff2356a4 --- /dev/null +++ b/data/reusables/permissions/push-protection-resolve-block.md @@ -0,0 +1 @@ +Users with **write** access diff --git a/data/reusables/permissions/security-enterprise-enable.md b/data/reusables/permissions/security-enterprise-enable.md new file mode 100644 index 0000000000..9335e5c41a --- /dev/null +++ b/data/reusables/permissions/security-enterprise-enable.md @@ -0,0 +1 @@ +Repository owners, organization owners, security managers, enterprise administrators, and users with the **admin** role