Skip to content

Commit

Permalink
Add more specifics to PVR notifications (#37229)
Browse files Browse the repository at this point in the history
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
  • Loading branch information
mchammer01 and sophietheking authored Jun 1, 2023
1 parent 64b48cb commit 0137f56
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 4 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ Notifications are different for incremental scans and historical scans.
1. On your notification settings page, under "Subscriptions", then under "Watching", select the **Notify me** dropdown.
1. Select "Email" as a notification option, then click **Save**.

![Screenshot of the notification settings for a user account. An element header, titled "Subscriptions", and a sub-header, titled "Watching", are shown. A checkbox, titled "Email", is highlighted with an orange outline.](/assets/images/help/notifications/secret-scanning-notification-options.png)
![Screenshot of the notification settings for a user account. An element header, titled "Subscriptions", and a sub-header, titled "Watching", are shown. A checkbox, titled "Email", is highlighted with an orange outline.](/assets/images/help/notifications/repository-watching-notification-options.png)
{% endif %}

{% data reusables.secret-scanning.notification-settings %}
{% data reusables.notifications.watch-settings %}

{% ifversion secret-scanning-backfills %}
### Historical scans
Expand All @@ -150,7 +150,7 @@ For historical scans, {% data variables.product.product_name %} notifies the fol

We do _not_ notify commit authors.

{% data reusables.secret-scanning.notification-settings %}
{% data reusables.notifications.watch-settings %}

{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ When a security researcher reports a vulnerability privately, you are notified a

## Managing security vulnerabilities that are privately reported

{% data variables.product.prodname_dotcom %} notifies repository maintainers when security researchers privately report vulnerabilities in their repository, and sends notifications if maintainers watch the repository or if they have notifications enabled for the repository. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)."
{% data reusables.security-advisory.private-vulnerability-reporting-configure-notifications %}

For more information about configuring notification preferences, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository#configuring-notifications-for-private-vulnerability-reporting)."

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,26 @@ The instructions in this article refer to enablement at repository level. For in
{% data reusables.security-advisory.private-vulnerability-reporting-security-researcher %}

{% data reusables.security-advisory.private-vulnerability-api %}

## Configuring notifications for private vulnerability reporting

{% data reusables.security-advisory.private-vulnerability-reporting-configure-notifications %}

Notifications depend on the user's notification preferences. You will receive an email notification if:
- You are watching the repository.
- You have enabled notifications for "All Activity".
- In your notification settings, under "Subscriptions", then under "Watching", you have selected to receive notifications by email.

{% data reusables.repositories.navigate-to-repo %}
1. To start watching the repository, select **{% octicon "eye" aria-hidden="true" %} Watch**.

![Screenshot of the repository's main page. A dropdown menu, titled "Watch", is highlighted with an orange outline.](/assets/images/help/repository/repository-watch-dropdown.png)

1. In the dropdown menu, click **All Activity**.
1. Navigate to the notification settings for your personal account. These are available at [https://github.com/settings/notifications](https://github.com/settings/notifications).
1. On your notification settings page, under "Subscriptions," then under "Watching," select the **Notify me** dropdown.
1. Select "Email" as a notification option, then click **Save**.

![Screenshot of the notification settings for a user account. An element header, titled "Subscriptions", and a sub-header, titled "Watching", are shown. A checkbox, titled "Email", is highlighted with an orange outline.](/assets/images/help/notifications/repository-watching-notification-options.png)

{% data reusables.notifications.watch-settings %}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ For organization owners and security managers, the benefits of using private vul

The instructions below refer to enablement at organization level. For information about enabling the feature for a repository, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository)."

{% data reusables.security-advisory.private-vulnerability-reporting-configure-notifications %}

For more information about configuring notification preferences, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository#configuring-notifications-for-private-vulnerability-reporting)."

## Enabling or disabling private vulnerability reporting for all the existing public repositories in an organization

{% data reusables.profile.access_org %}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
When a new vulnerability is privately reported on a repository where private vulnerability reporting is enabled, {% data variables.product.product_name %} notifies repository maintainers and security managers if:

- They're watching the repository for all activity.
- They have notifications enabled for the repository.

0 comments on commit 0137f56

Please sign in to comment.