Skip to content

Commit a28d660

Browse files
guntripCopilotsubatoi
authored
[EDI] Update notifications category (#57161)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 5dd34dd commit a28d660

File tree

13 files changed

+258
-186
lines changed

13 files changed

+258
-186
lines changed

content/subscriptions-and-notifications/concepts/about-notifications.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ To keep your subscriptions manageable, review your subscriptions and watched rep
5959

6060
To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request).
6161

62+
Each email notification that {% data variables.product.prodname_dotcom %} sends contains header information that you can use to filter notifications in your email client. For information about the headers included, see [AUTOTITLE](/subscriptions-and-notifications/reference/email-notification-headers).
63+
6264
You can customize and schedule push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#managing-your-notification-settings-with-github-mobile).
6365

6466
## Reasons for receiving notifications

content/subscriptions-and-notifications/get-started/configuring-notifications.md

Lines changed: 4 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -126,21 +126,7 @@ You can also send notifications for a specific repository to an email address. F
126126

127127
{% data reusables.notifications-v2.email-notification-caveats %}
128128

129-
## Filtering email notifications
130-
131-
Each email notification that {% data variables.product.prodname_dotcom %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications.
132-
133-
If you believe you're receiving notifications that don't belong to you, examine the `X-GitHub-Recipient` and `X-GitHub-Recipient-Address` headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user.
134-
135-
Email notifications from {% data variables.product.prodname_dotcom %} contain header information.
136-
137-
| Header | Information |
138-
| --- | --- |
139-
| `From` address | This address will always be {% ifversion fpt %}`notifications@github.com`{% elsif ghec %}`notifications@github.com` or `notifications@SUBDOMAIN.ghe.com`{% else %}the no-reply email address configured by your site administrator{% endif %}. |
140-
| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. |
141-
| `Cc` address | {% data variables.product.github %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% ifversion fpt %}`@noreply.github.com`{% elsif ghec %}`@noreply.github.com` or `@noreply.SUBDOMAIN.ghe.com`{% else %}based on the no-reply email address configured by your site administrator{% endif %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li><li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li><li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
142-
| `List-Id` field | This field identifies the name of the repository and its owner. The format of this address is always `OWNER/REPOSITORY <REPOSITORY.OWNER>`, e.g. `List-Id: grain-lang/grain <grain.grain-lang.{% data variables.product.product_url %}>`. |
143-
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). |
129+
Each email notification that {% data variables.product.prodname_dotcom %} sends contains header information that you can use to filter notifications in your email client. For information about the headers included, see [AUTOTITLE](/subscriptions-and-notifications/reference/email-notification-headers).
144130

145131
## Replying to email notifications
146132

@@ -163,9 +149,9 @@ The `reply-to` address on each email notification identifies the thread and the
163149
1. On the notifications settings page, choose how you receive notifications when:
164150
* There are updates in repositories you're watching or in a conversation you're participating in. For more information, see [About participating and watching notifications](#about-participating-and-watching-notifications).{% ifversion automatic-watching %}
165151
* You gain access to a new repository or you've joined a new team. For more information, see [Automatic watching](#automatic-watching).{% endif %}
166-
* There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see [{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options). {% ifversion fpt or ghec %}
167-
* There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see [{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options).{% endif %}
168-
* There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see [Organization alerts notification options](#organization-alerts-notification-options).
152+
* There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see [AUTOTITLE](/subscriptions-and-notifications/how-tos/managing-security-notifications). {% ifversion fpt or ghec %}
153+
* There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/subscriptions-and-notifications/how-tos/managing-github-actions-notifications).{% endif %}
154+
* There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see [AUTOTITLE](/subscriptions-and-notifications/how-tos/managing-organization-notifications).
169155

170156
{% ifversion automatic-watching %}
171157

@@ -195,82 +181,6 @@ You can choose whether to watch or unwatch an individual repository. You can als
195181

196182
For example, if you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues.
197183

198-
## Choosing where your organization’s email notifications are sent
199-
200-
If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address.
201-
202-
{% data reusables.notifications-v2.email-notification-caveats %}
203-
204-
{% data reusables.notifications.access_notifications %}
205-
{% data reusables.notifications-v2.manage-notifications %}
206-
1. Under "Default notifications email", select the email address you'd like notifications sent to.
207-
{% ifversion ghes %}
208-
1. Click **Save**.{% endif %}
209-
210-
### Customizing email routes per organization
211-
212-
If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address).{% endif %}
213-
214-
{% data reusables.notifications.access_notifications %}
215-
{% data reusables.notifications-v2.manage-notifications %}
216-
{% ifversion update-notification-settings-22 %}
217-
1. Under "Default notifications email", click **Custom routing**.
218-
219-
![Screenshot of the "Default notifications email" section. A button, titled "Custom routing", is highlighted with an orange outline.](/assets/images/help/notifications/custom-router-emphasized.png)
220-
221-
1. Click **Add new route**.
222-
223-
1. Select the **Pick organization** dropdown, then click the organization you want to customize.
224-
1. Select one of your verified email addresses, then click **Save**.
225-
226-
![Screenshot of the "Custom Routing" page. A dropdown menu, showing a user's available email addresses, is highlighted with an orange outline.](/assets/images/help/notifications/select-email-address-custom-routing-and-save.png)
227-
{% else %}
228-
1. Under "Custom routing," find your organization's name in the list.
229-
230-
1. Click **Edit** next to the email address you want to change.
231-
232-
1. Select one of your verified email addresses, then click **Save**.
233-
234-
{% endif %}
235-
236-
## {% data variables.product.prodname_dependabot_alerts %} notification options
237-
238-
The notification options for your user account are available at [https://github.com/settings/notifications](https://github.com/settings/notifications). You can configure notification settings for each repository, in the repository watch settings.
239-
240-
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
241-
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}
242-
{% data reusables.notifications.vulnerable-dependency-notification-options %}
243-
244-
For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts).
245-
246-
## {% data variables.product.prodname_secret_scanning_caps %} notification options
247-
248-
{% data reusables.secret-scanning.secret-scanning-configure-notifications %}
249-
250-
For more information on how to configure notifications for {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts).
251-
252-
## {% data variables.product.prodname_actions %} notification options
253-
254-
For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates.
255-
256-
{% ifversion update-notification-settings-22 %}
257-
1. On the "Notification settings" page, under "System", then under "Actions", select the **Don't notify** dropdown menu.
258-
259-
![Screenshot of the "System" section of the notification settings. Under "Actions," a dropdown menu, titled "Don't notify", is outlined in orange.](/assets/images/help/notifications/github-actions-customize-notifications.png)
260-
1. To opt into web notifications, from the dropdown menu, select "On {% data variables.product.prodname_dotcom %}."
261-
262-
To opt into email notifications, from the dropdown menu, select "Email."
263-
1. Optionally, to only receive notifications for failed workflow runs, from the dropdown menu, select "Only notify for failed workflows", then click **Save**.{% endif %}
264-
265-
{% ifversion ghes %}
266-
On the "Notification settings" page, select "Email" or "Web" notifications. Optionally, to only receive notifications for failed workflow runs, select "Send notifications for failed workflows only".
267-
268-
![Screenshot of the "Actions" section of "Notification settings" with checkboxes: "Email", "Web", and "Send notifications for failed workflows only."](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %}
269-
270-
## Organization alerts notification options
271-
272-
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", deselect **Email**.
273-
274184
## Managing your notification settings with {% data variables.product.prodname_mobile %}
275185

276186
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.

content/subscriptions-and-notifications/how-tos/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,9 @@ versions:
99
children:
1010
- /managing-subscriptions-for-activity-on-github
1111
- /viewing-and-triaging-notifications
12+
- /managing-organization-notifications
13+
- /managing-github-actions-notifications
14+
- /managing-security-notifications
15+
- /managing-marketing-emails-from-github
1216
---
1317

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Managing GitHub Actions notifications
3+
intro: Learn about managing how notifications from {% data variables.product.prodname_actions %} are delivered.
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
8+
topics:
9+
- Notifications
10+
shortTitle: Manage Actions notifications
11+
---
12+
13+
For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates.
14+
15+
{% ifversion update-notification-settings-22 %}
16+
1. On the "Notification settings" page, under "System", then under "Actions", select the **Don't notify** dropdown menu.
17+
18+
![Screenshot of the "System" section of the notification settings. Under "Actions", a dropdown menu titled "Don't notify" is outlined in orange.](/assets/images/help/notifications/github-actions-customize-notifications.png)
19+
1. To opt in to web notifications, from the dropdown menu, select "On {% data variables.product.prodname_dotcom %}."
20+
21+
To opt in to email notifications, from the dropdown menu, select "Email."
22+
1. Optionally, to only receive notifications for failed workflow runs, from the dropdown menu, select "Only notify for failed workflows", then click **Save**.{% endif %}
23+
24+
{% ifversion ghes %}
25+
On the "Notification settings" page, select "Email" or "Web" notifications. Optionally, to only receive notifications for failed workflow runs, select "Send notifications for failed workflows only".
26+
27+
![Screenshot of the "Actions" section of "Notification settings" with checkboxes: "Email", "Web", and "Send notifications for failed workflows only."](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %}

content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-marketing-emails-from-github.md renamed to content/subscriptions-and-notifications/how-tos/managing-marketing-emails-from-github.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ redirect_from:
88
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/managing-marketing-emails-from-github
99
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github
1010
- /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github
11+
- /subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-marketing-emails-from-github
1112
versions:
1213
fpt: '*'
1314
ghec: '*'
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Managing organization notifications
3+
intro: Learn how to control where notifications from your organization are delivered.
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
8+
topics:
9+
- Notifications
10+
shortTitle: Manage organization notifications
11+
---
12+
13+
## Organization alerts notification options
14+
15+
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", deselect **Email**.
16+
17+
## Choosing where your organization’s email notifications are sent
18+
19+
If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address.
20+
21+
{% data reusables.notifications-v2.email-notification-caveats %}
22+
23+
{% data reusables.notifications.access_notifications %}
24+
{% data reusables.notifications-v2.manage-notifications %}
25+
1. Under "Default notifications email", select the email address you'd like notifications sent to.
26+
{% ifversion ghes %}
27+
1. Click **Save**.{% endif %}
28+
29+
### Customizing email routes per organization
30+
31+
If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address).{% endif %}
32+
33+
{% data reusables.notifications.access_notifications %}
34+
{% data reusables.notifications-v2.manage-notifications %}
35+
{% ifversion update-notification-settings-22 %}
36+
1. Under "Default notifications email", click **Custom routing**.
37+
38+
![Screenshot of the "Default notifications email" section. A button, titled "Custom routing", is highlighted with an orange outline.](/assets/images/help/notifications/custom-router-emphasized.png)
39+
40+
1. Click **Add new route**.
41+
42+
1. Select the **Pick organization** dropdown, then click the organization you want to customize.
43+
1. Select one of your verified email addresses, then click **Save**.
44+
45+
![Screenshot of the "Custom Routing" page. A dropdown menu, showing a user's available email addresses, is highlighted with an orange outline.](/assets/images/help/notifications/select-email-address-custom-routing-and-save.png)
46+
{% else %}
47+
1. Under "Custom routing", find your organization's name in the list.
48+
49+
1. Click **Edit** next to the email address you want to change.
50+
51+
1. Select one of your verified email addresses, then click **Save**.
52+
53+
{% endif %}

0 commit comments

Comments
 (0)