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
Copy file name to clipboardExpand all lines: learn-pr/github/configure-use-secret-scanning-github-repository/includes/1-introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ GitHub's security features help keep code and secrets secure in repositories and
2
2
3
3
Imagine that you're the administrator of a GitHub project involving several repositories that communicate with multiple external services. You'd like to make sure that no authentication credentials for these services get committed in the repositories of the project. Luckily, your company just purchased a GitHub Advanced Security license that includes secret scanning, a GitHub feature that does just that!
4
4
5
-
To configure and use secret scanning for your project, you really need to understand what secret scanning is, how it works and the options available to you according to your use case.
5
+
To configure and use secret scanning for your project, you really need to understand what secret scanning is, how it works, and the options available to you according to your use case.
Copy file name to clipboardExpand all lines: learn-pr/github/configure-use-secret-scanning-github-repository/includes/3-configure-secret-scanning.md
+8-17Lines changed: 8 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,29 +6,20 @@ This unit walks you through the necessary steps to enable secret scanning at the
6
6
7
7
Follow these steps to enable secret scanning and push protection on a private repository:
8
8
9
-
1. In your repository, navigate to **Settings > Code security and analysis**.
10
-
1. Select the **Enable** button next to **GitHub Advanced Security**
11
-
1. Review the impact of enabling Advanced Security and select **Enable GitHub Advanced Security for this repository**.
12
-
1. Select the **Enable** button next to **Secret scanning**. If you see a **Disable** button, it means that secret scanning was already enabled at organization level.
9
+
1. In your repository, navigate to **Settings**.
10
+
1. In the **Security** section select **Advanced Security**.
11
+
1. Select the **Enable** button next to **Secret Protection**
12
+
1. Review the impact of enabling and select **Enable Secret Protection**.
13
+
1. If you see a **Disable** button, it means that secret scanning was already enabled at organization level.
13
14
1. Select the **Enable** button next to **Push protection**.
14
15
15
16
:::image type="content" source="../media/enable-secret-scanning-repo-settings.png" alt-text="Screenshot of secret scanning enabled in repository settings.":::
16
17
17
18
## Enable secret scanning for an organization
18
19
19
-
Enabling secret scanning at the organization level ensures that secret scanning is enabled by default on all private repositories where GitHub Advanced Security is enabled.
20
+
Enabling secret scanning at the organization level ensures that secret scanning is enabled by default on all private repositories where GitHub Advanced Security is enabled. In order to configure, you'll need to setup [GitHub Advanced Security](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security).
20
21
21
-
Follow these steps to enable secret scanning and push protection for an organization:
22
-
23
-
1. In your organization, navigate to **Settings > Code security and analysis**.
24
-
2. Select the **Enable all** button next to **GitHub Advanced Security**.
25
-
3. Review the impact of enabling Advanced Security on all repositories and select **Enable all**.
26
-
4. Select the **Enable all** button next to **Secret scanning** and select **Enable for eligible repositories**.
27
-
- (Optional) Select **Automatically enable for new public repositories and repositories with GitHub Advanced Security enabled**.
28
-
5. Select the **Enable all** button next to **Push protection** and select **Enable for eligible repositories**.
29
-
- (Optional) Select **Automatically enable for repositories added to secret scanning**.
30
-
31
-
:::image type="content" source="../media/enable-secret-scanning-org-settings.png" alt-text="Screenshot of enabling secret scanning in organization settings.":::
22
+
Once setup, you can configure [Global Secret Scanning settings](https://docs.github.com/en/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#configuring-global-secret-scanning-settings).
32
23
33
24
## Exclude files from being scanned
34
25
@@ -67,7 +58,7 @@ You'll receive an email notification if:
67
58
68
59
## Configure recipients of secret scanning alerts
69
60
70
-
Repository and organization administrators can give view access to security alerts to people or teams who have write access to the repository under **Settings > Code security and analysis > Access to alerts**:
61
+
Repository and organization administrators can give view access to security alerts to people or teams who have write access to the repository under **Settings > Security > Advanced Security > Access to Alerts**:
71
62
72
63
:::image type="content" source="../media/access-to-alerts.png" alt-text="Screenshot of Access to alerts section with Search for people or teams field highlighted.":::
0 commit comments