You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -40,7 +40,6 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
40
40
-[Legacy filepaths and redirects for links](#legacy-filepaths-and-redirects-for-links)
41
41
-[Index pages](#index-pages)
42
42
-[Home page](#homepage)
43
-
-[Creating new product guides pages](#creating-new-product-guides-pages)
44
43
45
44
## Frontmatter
46
45
@@ -230,27 +229,6 @@ defaultPlatform: linux
230
229
defaultTool: cli
231
230
```
232
231
233
-
### `learningTracks`
234
-
- Purpose: Render a list of learning tracks on a product's sub-landing page.
235
-
- type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
236
-
- Optional
237
-
238
-
**Note: the featured track is set by a specific property in the learning tracks YAML. See that [README](../data/learning-tracks/README.md) for details.*
239
-
240
-
### `includeGuides`
241
-
- Purpose: Render a list of articles, filterable by `contentType`. Only applicable when used with `layout: product-guides`.
- Type: `String`, one of `get-started`, `concepts`, `how-tos`, `reference`, `tutorials`, `rai`, `landing` (only applies to `content/<product>/index.md` files).
@@ -433,13 +429,3 @@ The homepage is the main Table of Contents file for the docs site. The homepage
433
429
434
430
`childGroups` is an array of mappings containing a `name` for the group, an optional `icon` for the group, and an array of `children`. The `children` in the array must be present in the `children` frontmatter property.
435
431
436
-
### Creating new product guides pages
437
-
438
-
To create a product guides page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
439
-
440
-
1. Use the product guides page template by referencing `layout: product-guides`.
441
-
1. (optional) Include the learning tracks in [`learningTracks`](#learningTracks).
442
-
1. (optional) Define which articles to include with [`includeGuides`](#includeGuides).
443
-
444
-
If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
445
-
If using `includeGuides`, make sure each of the articles in this list has [`contentType`](#contenttype) in its frontmatter.
Copy file name to clipboardExpand all lines: content/code-security/concepts/secret-security/about-push-protection.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ category:
18
18
19
19
## What is push protection?
20
20
21
-
Push protection is a {% data variables.product.prodname_secret_scanning %} feature designed to prevent sensitive information, such as secrets or tokens, from ever being pushed to your repository. Unlike {% data variables.product.prodname_secret_scanning %}, which detects secrets after they have been committed, push protection proactively scans your code for secrets during the push process, then blocks the push if any are detected.
21
+
Push protection is a {% data variables.product.prodname_secret_scanning %} feature designed to prevent hardcoded credentials, such as secrets or tokens, from ever being pushed to your repository. Rather than alerting you to credential leaks after the fact, push protection blocks pushes that contain secrets _before_ they reach your repository.
22
22
23
23
## How push protection works
24
24
@@ -74,9 +74,9 @@ If you want greater control over which contributors can bypass push protection a
74
74
75
75
## Benefits of push protection
76
76
77
-
***Preventative security:** Push protection acts as a frontline defense mechanism by scanning code for secrets at the time of the push. This preventative approach helps to catch potential issues before they are merged into a repository.
77
+
***Preventative security:** Push protection acts as a frontline defense mechanism by scanning code for hardcoded secrets at the time of the push. This preventative approach helps prevent credential leaks before they become ingrained in the repository's history, making it easier to address and remediate threats.
78
78
***Immediate feedback:** Developers receive instant feedback if a potential secret is detected during a push attempt. This immediate notification allows for quick remediation, reducing the likelihood of sensitive information being exposed.
79
-
***Reduced risk of data leaks:** By blocking commits that contain sensitive information, push protection significantly reduces the risk of accidental data leaks. This helps in safeguarding against unauthorized access to your infrastructure, services, and data.
79
+
***Reduced risk of credential leaks:** By blocking commits that contain hardcoded credentials, push protection significantly reduces the risk of accidental credential leaks and secret sprawl. This helps in safeguarding against potential breaches and maintaining the integrity of the codebase.
80
80
***Efficient secret management:** Instead of retrospectively dealing with exposed secrets, developers can address issues at the source. This makes secret management more efficient and less time-consuming.
81
81
***Bypass functionality for flexibility:** For cases where false positives occur or when certain patterns are necessary, you can bypass push protection for users, and designated users can use the delegated bypass feature to bypass push protection for repositories. {% ifversion push-protection-org-enterprise-exemptions %}Additionally, you can exempt trusted actors {% ifversion push-protection-repo-exemptions %}{% else %}at the organization and enterprise levels {% endif %}from push protection entirely. {% endif %}This provides flexibility without compromising overall security.
82
82
***Ability to detect custom patterns (for repositories in organizations):** Organizations can define custom patterns for detecting secrets unique to their environment. This customization ensures that push protection can effectively identify and block even non-standard secrets.
Copy file name to clipboardExpand all lines: content/code-security/concepts/secret-security/about-secret-scanning.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ category:
19
19
- Protect your secrets
20
20
---
21
21
22
-
When credentials like API keys and passwords are committed to repositories, they become targets for unauthorized access. {% data variables.product.prodname_secret_scanning_caps %} automatically detects these exposed secrets so you can secure them before they're exploited.
22
+
When credentials like API keys and passwords are committed to repositories as hardcoded secrets, they become targets for unauthorized access. {% data variables.product.prodname_secret_scanning_caps %} automatically detects credential leaks so you can secure them before they're exploited.
23
23
24
24
{% ifversion secret-risk-assessment %}
25
25
@@ -32,15 +32,15 @@ When credentials like API keys and passwords are committed to repositories, they
32
32
33
33
## How secret scanning protects your code
34
34
35
-
{% data variables.product.prodname_secret_scanning_caps %} scans your entire Git history on all branches of your repository for API keys, passwords, tokens, and other known secret types. {% data variables.product.github %} also periodically rescans repositories when new secret types are added.
35
+
{% data variables.product.prodname_secret_scanning_caps %} scans your entire Git history on all branches of your repository for hardcoded credentials, including API keys, passwords, tokens, and other known secret types. This helps you identify secret sprawl, the uncontrolled proliferation of credentials across repositories, before it becomes a security risk. {% data variables.product.github %} also periodically rescans repositories when new secret types are added.
36
36
37
37
{% data variables.product.github %} also automatically scans:
38
38
39
39
{% data reusables.secret-scanning.what-is-scanned %}
40
40
41
41
### {% data variables.product.prodname_secret_scanning_caps %} alerts and remediation
42
42
43
-
When {% data variables.product.prodname_secret_scanning %} finds a potential secret, {% data variables.product.github %} generates an alert on your repository's **{% data variables.product.prodname_security_and_quality_tab %}** tab with details about the exposed credential.
43
+
When {% data variables.product.prodname_secret_scanning %} detects a credential leak, {% data variables.product.github %} generates an alert on your repository's **{% data variables.product.prodname_security_and_quality_tab %}** tab with details about the exposed credential.
44
44
45
45
When you receive an alert, rotate the affected credential immediately to prevent unauthorized access. While you can also remove secrets from your Git history, this is time-intensive and often unnecessary if you've already revoked the credential.
Copy file name to clipboardExpand all lines: content/code-security/concepts/secret-security/about-secret-security-with-github.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ category:
14
14
- Protect your secrets
15
15
---
16
16
17
-
Exposed secrets in your repositories can lead to unauthorized access, data breaches, and significant costs to your organization. For details about these risks and how to protect against them, see [AUTOTITLE](/code-security/concepts/secret-security/secret-leakage-risks).
17
+
Hardcoded credentials in your repositories can lead to credential leaks, unauthorized access, data breaches, and significant costs to your organization. For details about these risks and how to protect against them, see [AUTOTITLE](/code-security/concepts/secret-security/secret-leakage-risks).
18
18
19
19
{% data variables.product.github %} provides tools to help you understand and address your organization's exposure to leaked secrets:
20
20
@@ -23,7 +23,7 @@ Exposed secrets in your repositories can lead to unauthorized access, data breac
23
23
24
24
## Secret risk assessment
25
25
26
-
The secret risk assessment provides organization owners and security managers with a free point-in-time scan of their organization's repositories to identify leaked secrets like API keys, tokens, and passwords.
26
+
The secret risk assessment provides organization owners and security managers with a free point-in-time scan of their organization's repositories to identify hardcoded credentials like API keys, tokens, and passwords, and understand the extent of secret sprawl across your organization.
27
27
28
28
{% data variables.secret-scanning.secret-risk-assessment-cta-product %}
While the {% data variables.product.prodname_secret_risk_assessment %} provides a point-in-time view of your organization's current secret exposure, {% data variables.product.prodname_GH_secret_protection %}:
53
53
54
54
***Implements continuous monitoring** and expands scanned surfaces beyond code to include pull requests, issues, wikis, and discussions
55
-
***Prevents secret leaks** by blocking commits containing secrets before they are saved to {% data variables.product.github %}
55
+
***Prevents credential leaks** by blocking commits containing hardcoded secrets before they are saved to {% data variables.product.github %}
56
56
***Creates actionable alerts** that can be grouped into campaigns and assigned to team members for remediation
57
57
***Meets your specific needs** by scanning for patterns unique to your organization and unstructured secrets like passwords
58
58
***Supports governance at scale** with settings dictating who can bypass protections and dismiss alerts
59
59
***Surfaces key analytics** through a view dedicated to your organization's secret security
60
60
61
-
Through these features, {% data variables.product.prodname_GH_secret_protection %} provides complete coverage for your organization, reducing the risk of costly secret leaksand high-effort remediation processes.
61
+
Through these features, {% data variables.product.prodname_GH_secret_protection %} provides complete coverage for your organization, reducing the risk of costly credential leaks, secret sprawl, and high-effort remediation.
62
62
63
63
For more information about the specific features of {% data variables.product.prodname_GH_secret_protection %}, see [AUTOTITLE](/code-security/getting-started/github-security-features#available-with-github-secret-protection).
0 commit comments