1
0
mirror of synced 2025-12-22 03:16:52 -05:00

Update info on notifications to include new "security alerts" type (#19082)

This commit is contained in:
Felicity Chapman
2021-05-05 16:55:12 +01:00
committed by GitHub
parent eaddbc5db7
commit 6187dc4518
8 changed files with 24 additions and 16 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

@@ -73,7 +73,7 @@ You can use a *secret_scanning.yml* file to exclude directories from {% data var
{% endnote %}
You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-alerts)."
You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)."
### Further reading

View File

@@ -14,7 +14,7 @@ topics:
{% data reusables.secret-scanning.beta %}
### Managing alerts
### Managing {% data variables.product.prodname_secret_scanning %} alerts
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
@@ -49,3 +49,11 @@ Once a secret has been committed to a repository, you should consider the secret
- For a compromised {% data variables.product.prodname_dotcom %} personal access token, delete the compromised token, create a new token, and update any services that use the old token. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)."
- For all other secrets, first verify that the secret committed to {% data variables.product.product_name %} is valid. If so, create a new secret, update any services that use the old secret, and then delete the old secret.
{% if currentVersion == "free-pro-team@latest" %}
### Configuring notifications for {% data variables.product.prodname_secret_scanning %} alerts
When a new secret is detected, {% data variables.product.prodname_dotcom %} notifies all users with access to security alerts for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts, or are the author of the commit that contains the secret and are not ignoring the repository.
For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" and "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)."
{% endif %}

View File

@@ -26,11 +26,8 @@ You can choose to receive ongoing updates about specific activity on {% data var
You can choose to subscribe to notifications for:
- A conversation in a specific issue, pull request, or gist.
- All activity in a repository or team discussion.
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}.
{% if currentVersion == "free-pro-team@latest" %}
- Issues, pulls requests, releases and discussions (if enabled) in a repository.
{% endif %}
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}.{% if currentVersion == "free-pro-team@latest" %}
- Issues, pulls requests, releases, security alerts, and discussions (if enabled) in a repository.{% endif %}{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
- Releases in a repository.
{% endif %}

View File

@@ -57,7 +57,7 @@ In addition, you can receive and triage notifications on your mobile device with
#### Benefits of using an email client for notifications
One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)."
One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on {% data variables.product.prodname_dotcom %} unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)."
Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels.
@@ -71,11 +71,12 @@ To see repositories that you're watching, go to your [watching page](https://git
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
#### Configuring notifications
{% endif %}
You can configure notifications for a repository on the repository page, or on your watching page.{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
You can configure notifications for a repository on the repository page, or on your watching page.{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
#### About custom notifications
{% data reusables.notifications-v2.custom-notifications-beta %}
You can customize notifications for a repository, for example, you can choose to only be notified when updates to one or more types of events (issues, pull request, releases, discussions) happen within a repository, or ignore all notifications for a repository.
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events (issues, pull request, releases, security alerts, discussions) happen within a repository, or ignore all notifications for a repository.
{% endif %} For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below.
#### Participating in conversations
@@ -156,7 +157,7 @@ If "Automatically watch repositories" is disabled, then you will not automatical
### Configuring your watch settings for an individual repository
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, security alerts, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
{% data reusables.repositories.navigate-to-repo %}
2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option.

View File

@@ -69,5 +69,5 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
{% if currentVersion == "free-pro-team@latest" %}
- unwatch a repository
- ignore all notifications for a repository
- customize the types of event you receive notifications for (issues, pull requests, releases or discussions, if enabled)
- customize the types of event you receive notifications for (issues, pull requests, releases, security alerts, or discussions, if enabled)
{% endif %}

View File

@@ -78,7 +78,7 @@ Many people forget about repositories that they've chosen to watch in the past.
{% tip %}
**Tip:** Instead of watching a repository, consider only receiving notifications {% if currentVersion == "free-pro-team@latest" %}when there are updates to issues, pull requests, releases or discussions (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
**Tip:** Instead of watching a repository, consider only receiving notifications {% if currentVersion == "free-pro-team@latest" %}when there are updates to issues, pull requests, releases, security alerts, or discussions (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned.

View File

@@ -1,3 +1,5 @@
You can choose the delivery method for notifications about {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} on repositories that you are watching, as well as the frequency at which the notifications are sent to you.
{% if currentVersion == "free-pro-team@latest" %}
You can choose the delivery method and frequency of notifications about {% data variables.product.prodname_dependabot_alerts %} on repositories that you are watching or where you have subscribed to notifications for security alerts.
{% else %}
You can choose the delivery method for notifications about {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} on repositories that you are watching, as well as the frequency at which the notifications are sent to you.
{% endif %}