1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Scannability improvements to front matter for push protection articles (#52570)

Co-authored-by: Courtney Claessens <courtneycl@github.com>
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
This commit is contained in:
mc
2024-10-15 08:11:43 +01:00
committed by GitHub
parent 4f6a48113e
commit ed27e7e15c
14 changed files with 41 additions and 20 deletions

View File

@@ -2,7 +2,7 @@
title: Enabling push protection for your repository title: Enabling push protection for your repository
shortTitle: Enable push protection shortTitle: Enable push protection
intro: 'With push protection, {% data variables.product.prodname_secret_scanning %} blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block.' intro: 'With push protection, {% data variables.product.prodname_secret_scanning %} blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block.'
product: '{% data reusables.gated-features.secret-scanning %}' permissions: '{% data reusables.permissions.push-protection %}'
versions: versions:
fpt: '*' fpt: '*'
ghes: '*' ghes: '*'

View File

@@ -1,7 +1,7 @@
--- ---
title: About delegated bypass for push protection title: About delegated bypass for push protection
intro: 'You can control which teams or roles have the ability to bypass push protection in your organization or repository.' intro: 'You can control which teams or roles have the ability to bypass push protection in your organization or repository.'
product: '{% data reusables.gated-features.push-protection-for-repos %}' product: '{% data reusables.gated-features.delegated-bypass %}'
versions: versions:
feature: push-protection-delegated-bypass feature: push-protection-delegated-bypass
type: overview type: overview

View File

@@ -1,8 +1,7 @@
--- ---
title: Enabling delegated bypass for push protection title: Enabling delegated bypass for push protection
intro: 'You can use delegated bypass for your organization or repository to control who can push commits that contain secrets identified by {% data variables.product.prodname_secret_scanning %}.' intro: 'You can use delegated bypass for your organization or repository to control who can push commits that contain secrets identified by {% data variables.product.prodname_secret_scanning %}.'
product: '{% data reusables.gated-features.push-protection-for-repos %}' permissions: '{% data reusables.permissions.delegated-bypass %}'
permissions: 'Organization owners and repository administrators can enable delegated bypass for push protection for their organization and repository, respectively.'
versions: versions:
feature: push-protection-delegated-bypass feature: push-protection-delegated-bypass
type: how_to type: how_to

View File

@@ -1,8 +1,7 @@
--- ---
title: Managing requests to bypass push protection title: Managing requests to bypass push protection
intro: 'As a member of the bypass list for an organization or repository, you can review bypass requests from other members of the organization or repository.' intro: 'As a member of the bypass list for an organization or repository, you can review bypass requests from other members of the organization or repository.'
product: '{% data reusables.gated-features.push-protection-for-repos %}' permissions: '{% data reusables.permissions.delegated-bypass-list %}'
permissions: 'Members of the bypass list can process requests from non-members to bypass push protection.'
versions: versions:
feature: push-protection-delegated-bypass feature: push-protection-delegated-bypass
type: how_to type: how_to

View File

@@ -1,7 +1,7 @@
--- ---
title: Excluding folders and files from secret scanning title: Excluding folders and files from secret scanning
intro: 'You can customize {% data variables.product.prodname_secret_scanning %} to exclude directories or files from analysis, by configuring a `secret_scanning.yml` file in your repository.' intro: 'You can customize {% data variables.product.prodname_secret_scanning %} to exclude directories or files from analysis, by configuring a `secret_scanning.yml` file in your repository.'
product: '{% data reusables.gated-features.secret-scanning %}' permissions: '{% data reusables.permissions.secret-scanning-alerts %}'
shortTitle: Exclude folders and files shortTitle: Exclude folders and files
versions: versions:
fpt: '*' fpt: '*'

View File

@@ -2,7 +2,7 @@
title: Working with push protection from the command line title: Working with push protection from the command line
shortTitle: Push protection on 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.' 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.'
product: '{% data reusables.gated-features.secret-scanning %}' permissions: '{% data reusables.permissions.push-protection %}'
versions: versions:
fpt: '*' fpt: '*'
ghes: '*' ghes: '*'

View File

@@ -2,7 +2,7 @@
title: Working with push protection in the GitHub UI title: Working with push protection in the GitHub UI
shortTitle: 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.' intro: 'Learn your options for unblocking your commit when {% data variables.product.prodname_secret_scanning %} detects a secret in your changes.'
product: '{% data reusables.gated-features.secret-scanning %}' permissions: '{% data reusables.permissions.push-protection %}'
versions: versions:
fpt: '*' fpt: '*'
ghes: '*' ghes: '*'

View File

@@ -0,0 +1,13 @@
Delegated bypass requires push protection to be enabled for the organization or the repository. See "[AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection)."
Delegated bypass is available for the following repositories:
{% ifversion ghec %}
* 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
{% elsif ghes %}
* Organization-owned repositories with [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) enabled
{% endif %}

View File

@@ -1,6 +1,13 @@
{%- ifversion fpt or ghec %} Push protection for repositories and organizations is available for the following repository types:
Push protection for repositories and organizations is available for {% ifversion ghec %}user-owned {% endif %}public repositories for free. Organizations using {% data variables.product.prodname_ghe_cloud %} with a license for {% data variables.product.prodname_GH_advanced_security %} can also enable push protection on their private and internal repositories. {% ifversion fpt or ghec %}
{%- elsif ghes %} * {% ifversion ghec %}User-owned public{% elsif fpt %}Public{% endif %} repositories for free
Push protection is available for organization-owned repositories in {% data variables.product.product_name %} if your enterprise has a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} * 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{% ifversion ghec %}
* User namespace repositories belonging to {% data variables.product.prodname_emus %}{% endif %}
{% elsif ghes %}
* Organization-owned repositories with [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) enabled
{% endif %}

View File

@@ -1 +1,3 @@
Push protection for users is on by default and can be disabled in your personal account settings. Push protection for users is on by default on the following repository types:
* Public repositories

View File

@@ -0,0 +1,4 @@
* Organization owners
* Security managers
* Users in teams, default roles, or custom roles that have been added to the bypass list.{% ifversion push-protection-bypass-fine-grained-permissions %}
* Users who are assigned a custom role with the "review and manage {% data variables.product.prodname_secret_scanning %} bypass requests" fine-grained permission. {% endif %}

View File

@@ -0,0 +1 @@
Repository owners, organization owners, security managers, and users with the **admin** role

View File

@@ -0,0 +1 @@
Repository owners, organization owners, security managers, and users with the **admin** role

View File

@@ -1,6 +1 @@
Members {% ifversion push-protection-bypass-fine-grained-permissions %}with permission to review and manage bypass requests {% else %}of the bypass list{% endif %} are still protected from accidentally pushing secrets to a repository. If they attempt to push a commit containing a secret, their push is still blocked, but they can choose to bypass the block by specifying a reason for allowing the push. The following types of people can bypass push protection without requesting bypass privileges: Members {% ifversion push-protection-bypass-fine-grained-permissions %}with permission to review and manage bypass requests {% else %}of the bypass list{% endif %} are still protected from accidentally pushing secrets to a repository. If they attempt to push a commit containing a secret, their push is still blocked, but they can choose to bypass the block by specifying a reason for allowing the push.
* Organization owners
* Security managers
* Users in teams, default roles, or custom roles that have been added to the bypass list.{% ifversion push-protection-bypass-fine-grained-permissions %}
* Users who are assigned (either directly or via a team) a custom role with the "review and manage secret scanning bypass requests" fine-grained permission.{% endif %}