[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>
This commit is contained in:
Felix Guntrip
@@ -59,6 +59,8 @@ To keep your subscriptions manageable, review your subscriptions and watched rep
|
||||
|
||||
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).
|
||||
|
||||
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).
|
||||
|
||||
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).
|
||||
|
||||
## Reasons for receiving notifications
|
||||
|
||||
@@ -126,21 +126,7 @@ You can also send notifications for a specific repository to an email address. F
|
||||
|
||||
{% data reusables.notifications-v2.email-notification-caveats %}
|
||||
|
||||
## Filtering email notifications
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
Email notifications from {% data variables.product.prodname_dotcom %} contain header information.
|
||||
|
||||
| Header | Information |
|
||||
| --- | --- |
|
||||
| `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 %}. |
|
||||
| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. |
|
||||
| `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> |
|
||||
| `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 %}>`. |
|
||||
| `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). |
|
||||
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).
|
||||
|
||||
## Replying to email notifications
|
||||
|
||||
@@ -163,9 +149,9 @@ The `reply-to` address on each email notification identifies the thread and the
|
||||
1. On the notifications settings page, choose how you receive notifications when:
|
||||
* 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 %}
|
||||
* You gain access to a new repository or you've joined a new team. For more information, see [Automatic watching](#automatic-watching).{% endif %}
|
||||
* 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 %}
|
||||
* 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 %}
|
||||
* 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).
|
||||
* 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 %}
|
||||
* 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 %}
|
||||
* 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).
|
||||
|
||||
{% ifversion automatic-watching %}
|
||||
|
||||
@@ -195,82 +181,6 @@ You can choose whether to watch or unwatch an individual repository. You can als
|
||||
|
||||
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.
|
||||
|
||||
## Choosing where your organization’s email notifications are sent
|
||||
|
||||
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.
|
||||
|
||||
{% data reusables.notifications-v2.email-notification-caveats %}
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
1. Under "Default notifications email", select the email address you'd like notifications sent to.
|
||||
{% ifversion ghes %}
|
||||
1. Click **Save**.{% endif %}
|
||||
|
||||
### Customizing email routes per organization
|
||||
|
||||
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 %}
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
{% ifversion update-notification-settings-22 %}
|
||||
1. Under "Default notifications email", click **Custom routing**.
|
||||
|
||||
|
||||
|
||||
1. Click **Add new route**.
|
||||
|
||||
1. Select the **Pick organization** dropdown, then click the organization you want to customize.
|
||||
1. Select one of your verified email addresses, then click **Save**.
|
||||
|
||||
|
||||
{% else %}
|
||||
1. Under "Custom routing," find your organization's name in the list.
|
||||
|
||||
1. Click **Edit** next to the email address you want to change.
|
||||
|
||||
1. Select one of your verified email addresses, then click **Save**.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## {% data variables.product.prodname_dependabot_alerts %} notification options
|
||||
|
||||
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.
|
||||
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-options %}
|
||||
|
||||
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).
|
||||
|
||||
## {% data variables.product.prodname_secret_scanning_caps %} notification options
|
||||
|
||||
{% data reusables.secret-scanning.secret-scanning-configure-notifications %}
|
||||
|
||||
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).
|
||||
|
||||
## {% data variables.product.prodname_actions %} notification options
|
||||
|
||||
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.
|
||||
|
||||
{% ifversion update-notification-settings-22 %}
|
||||
1. On the "Notification settings" page, under "System", then under "Actions", select the **Don't notify** dropdown menu.
|
||||
|
||||
|
||||
1. To opt into web notifications, from the dropdown menu, select "On {% data variables.product.prodname_dotcom %}."
|
||||
|
||||
To opt into email notifications, from the dropdown menu, select "Email."
|
||||
1. Optionally, to only receive notifications for failed workflow runs, from the dropdown menu, select "Only notify for failed workflows", then click **Save**.{% endif %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
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".
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Organization alerts notification options
|
||||
|
||||
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**.
|
||||
|
||||
## Managing your notification settings with {% data variables.product.prodname_mobile %}
|
||||
|
||||
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.
|
||||
|
||||
@@ -9,5 +9,9 @@ versions:
|
||||
children:
|
||||
- /managing-subscriptions-for-activity-on-github
|
||||
- /viewing-and-triaging-notifications
|
||||
- /managing-organization-notifications
|
||||
- /managing-github-actions-notifications
|
||||
- /managing-security-notifications
|
||||
- /managing-marketing-emails-from-github
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: Managing GitHub Actions notifications
|
||||
intro: Learn about managing how notifications from {% data variables.product.prodname_actions %} are delivered.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
shortTitle: Manage Actions notifications
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
{% ifversion update-notification-settings-22 %}
|
||||
1. On the "Notification settings" page, under "System", then under "Actions", select the **Don't notify** dropdown menu.
|
||||
|
||||
|
||||
1. To opt in to web notifications, from the dropdown menu, select "On {% data variables.product.prodname_dotcom %}."
|
||||
|
||||
To opt in to email notifications, from the dropdown menu, select "Email."
|
||||
1. Optionally, to only receive notifications for failed workflow runs, from the dropdown menu, select "Only notify for failed workflows", then click **Save**.{% endif %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
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".
|
||||
|
||||
{% endif %}
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/managing-marketing-emails-from-github
|
||||
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github
|
||||
- /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github
|
||||
- /subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-marketing-emails-from-github
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Managing organization notifications
|
||||
intro: Learn how to control where notifications from your organization are delivered.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
shortTitle: Manage organization notifications
|
||||
---
|
||||
|
||||
## Organization alerts notification options
|
||||
|
||||
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**.
|
||||
|
||||
## Choosing where your organization’s email notifications are sent
|
||||
|
||||
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.
|
||||
|
||||
{% data reusables.notifications-v2.email-notification-caveats %}
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
1. Under "Default notifications email", select the email address you'd like notifications sent to.
|
||||
{% ifversion ghes %}
|
||||
1. Click **Save**.{% endif %}
|
||||
|
||||
### Customizing email routes per organization
|
||||
|
||||
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 %}
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
{% ifversion update-notification-settings-22 %}
|
||||
1. Under "Default notifications email", click **Custom routing**.
|
||||
|
||||
|
||||
|
||||
1. Click **Add new route**.
|
||||
|
||||
1. Select the **Pick organization** dropdown, then click the organization you want to customize.
|
||||
1. Select one of your verified email addresses, then click **Save**.
|
||||
|
||||
|
||||
{% else %}
|
||||
1. Under "Custom routing", find your organization's name in the list.
|
||||
|
||||
1. Click **Edit** next to the email address you want to change.
|
||||
|
||||
1. Select one of your verified email addresses, then click **Save**.
|
||||
|
||||
{% endif %}
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: Managing security notifications
|
||||
intro: Learn how to control notifications from {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_secret_scanning_caps %}.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
shortTitle: Manage security notifications
|
||||
---
|
||||
|
||||
## {% data variables.product.prodname_dependabot_alerts %} notification options
|
||||
|
||||
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.
|
||||
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-options %}
|
||||
|
||||
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).
|
||||
|
||||
## {% data variables.product.prodname_secret_scanning_caps %} notification options
|
||||
|
||||
{% data reusables.secret-scanning.secret-scanning-configure-notifications %}
|
||||
|
||||
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).
|
||||
@@ -16,7 +16,6 @@ topics:
|
||||
children:
|
||||
- /managing-notifications-from-your-inbox
|
||||
- /triaging-a-single-notification
|
||||
- /managing-marketing-emails-from-github
|
||||
shortTitle: Customize a workflow
|
||||
---
|
||||
|
||||
|
||||
@@ -17,10 +17,12 @@ topics:
|
||||
shortTitle: Manage from your inbox
|
||||
---
|
||||
|
||||
## About your inbox
|
||||
## Prerequisites
|
||||
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings).
|
||||
|
||||
## Accessing your inbox
|
||||
|
||||
To access your notifications inbox, in the upper-right corner of any page, click {% octicon "inbox" aria-label="The notifications inbox" %}.
|
||||
|
||||
Your inbox shows all of the notifications that you haven't unsubscribed to or marked as **Done.** You can customize your inbox to best suit your workflow using filters, viewing all or just unread notifications, and grouping your notifications to get a quick overview.
|
||||
@@ -55,7 +57,7 @@ By default, your inbox has filters for when you are assigned, participating in a
|
||||
|
||||
## Customizing your inbox with custom filters
|
||||
|
||||
You can add up to 15 of your own custom filters.
|
||||
You can add up to 15 of your own custom filters. For information about the available filters, see [AUTOTITLE](/subscriptions-and-notifications/reference/inbox-filters).
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
1. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="Customize filters" %}.
|
||||
@@ -63,96 +65,8 @@ You can add up to 15 of your own custom filters.
|
||||
> [!TIP]
|
||||
> You can quickly preview a filter's inbox results by creating a query in your inbox view and clicking **Save**, which opens the custom filter settings.
|
||||
|
||||
1. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see [Supported queries for custom filters](#supported-queries-for-custom-filters).
|
||||
1. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see [AUTOTITLE](/subscriptions-and-notifications/reference/inbox-filters).
|
||||
|
||||
|
||||
|
||||
1. Click **Create**.
|
||||
|
||||
## Custom filter limitations
|
||||
|
||||
Custom filters do not currently support:
|
||||
|
||||
* Full text search in your inbox, including searching for pull request or issue titles
|
||||
* Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests.
|
||||
* Creating more than 15 custom filters
|
||||
* Changing the default filters or their order
|
||||
* Search [exclusion](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`
|
||||
|
||||
## Supported queries for custom filters
|
||||
|
||||
These are the types of filters that you can use:
|
||||
* Filter by repository with `repo:`
|
||||
* Filter by discussion type with `is:`
|
||||
* Filter by notification reason with `reason:`{% ifversion fpt or ghec %}
|
||||
* Filter by notification author with `author:`
|
||||
* Filter by organization with `org:`{% endif %}
|
||||
|
||||
### Supported `repo:` queries
|
||||
|
||||
To add a `repo:` filter, you must include the owner of the repository in the query: `repo:owner/repository`. An owner is the organization or the user who owns the {% data variables.product.prodname_dotcom %} asset that triggers the notification. For example, `repo:octo-org/octo-repo` will show notifications triggered in the octo-repo repository within the octo-org organization.
|
||||
|
||||
### Supported `is:` queries
|
||||
|
||||
To filter notifications for specific activity on {% data variables.product.prodname_dotcom %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`.
|
||||
|
||||
* `is:check-suite`
|
||||
* `is:commit`
|
||||
* `is:gist`
|
||||
* `is:issue-or-pull-request`
|
||||
* `is:release`
|
||||
* `is:repository-invitation`
|
||||
* `is:repository-vulnerability-alert`{% ifversion fpt or ghec %}
|
||||
* `is:repository-advisory`{% endif %}{% ifversion fpt or ghec %}
|
||||
* `is:discussion`{% endif %}
|
||||
|
||||
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts).
|
||||
|
||||
You can also use the `is:` query to describe how the notification was triaged.
|
||||
|
||||
* `is:saved`
|
||||
* `is:done`
|
||||
* `is:unread`
|
||||
* `is:read`
|
||||
|
||||
### Supported `reason:` queries
|
||||
|
||||
To filter notifications by why you've received an update, you can use the `reason:` query. For example, to see notifications when you (or a team you're on) is requested to review a pull request, use `reason:review-requested`. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications#reasons-for-receiving-notifications).
|
||||
|
||||
| Query | Description |
|
||||
|-----------------|-------------|
|
||||
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
|
||||
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
|
||||
| `reason:comment`| When you commented on an issue or pull request.
|
||||
| `reason:participating` | When you have commented on an issue or pull request or you have been @mentioned.
|
||||
| `reason:invitation` | When you're invited to a team, organization, or repository.
|
||||
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
|
||||
| `reason:mention` | You were directly @mentioned.
|
||||
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.
|
||||
| `reason:security-alert` | When a security alert is issued for a repository.
|
||||
| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged.
|
||||
| `reason:team-mention` | When a team you're a member of is @mentioned.
|
||||
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
### Supported `author:` queries
|
||||
|
||||
To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`.
|
||||
|
||||
### Supported `org:` queries
|
||||
|
||||
To filter notifications by organization, you can use the `org` query. The organization you need to specify in the query is the organization of the repository for which you are being notified on {% data variables.product.prodname_dotcom %}. This query is useful if you belong to several organizations, and want to see notifications for a specific organization.
|
||||
|
||||
For example, to see notifications from the octo-org organization, use `org:octo-org`.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## {% data variables.product.prodname_dependabot %} custom filters
|
||||
|
||||
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters:
|
||||
* `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
|
||||
* `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
|
||||
* `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests.
|
||||
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).
|
||||
|
||||
@@ -26,6 +26,7 @@ children:
|
||||
- /concepts
|
||||
- /how-tos
|
||||
- /tutorials
|
||||
- /reference
|
||||
shortTitle: Subscriptions & notifications
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Email notification headers
|
||||
intro: 'Learn how to filter email notifications by using information in the headers.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
>[!NOTE] 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.
|
||||
|
||||
| Header | Information |
|
||||
| --- | --- |
|
||||
| `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 %}. |
|
||||
| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. |
|
||||
| `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> |
|
||||
| `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 %}>`. |
|
||||
| `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). |
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: Inbox filters
|
||||
intro: 'Learn about filtering notifications in your {% data variables.product.prodname_dotcom %} inbox.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
---
|
||||
|
||||
You can create custom filters for your inbox using the following supported filters. For more information about creating custom filters, see [AUTOTITLE](/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox#customizing-your-inbox-with-custom-filters).
|
||||
|
||||
## Custom filter limitations
|
||||
|
||||
Custom filters do not currently support:
|
||||
|
||||
* Full text search in your inbox, including searching for pull request or issue titles
|
||||
* Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests.
|
||||
* Creating more than 15 custom filters
|
||||
* Changing the default filters or their order
|
||||
* Search [exclusion](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`
|
||||
|
||||
## Supported queries for custom filters
|
||||
|
||||
These are the types of filters that you can use:
|
||||
* Filter by repository with `repo:`
|
||||
* Filter by discussion type with `is:`
|
||||
* Filter by notification reason with `reason:`{% ifversion fpt or ghec %}
|
||||
* Filter by notification author with `author:`
|
||||
* Filter by organization with `org:`{% endif %}
|
||||
|
||||
### Supported `repo:` queries
|
||||
|
||||
To add a `repo:` filter, you must include the owner of the repository in the query: `repo:owner/repository`. An owner is the organization or the user who owns the {% data variables.product.prodname_dotcom %} asset that triggers the notification. For example, `repo:octo-org/octo-repo` will show notifications triggered in the octo-repo repository within the octo-org organization.
|
||||
|
||||
### Supported `is:` queries
|
||||
|
||||
To filter notifications for specific activity on {% data variables.product.prodname_dotcom %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`.
|
||||
|
||||
* `is:check-suite`
|
||||
* `is:commit`
|
||||
* `is:gist`
|
||||
* `is:issue-or-pull-request`
|
||||
* `is:release`
|
||||
* `is:repository-invitation`
|
||||
* `is:repository-vulnerability-alert`{% ifversion fpt or ghec %}
|
||||
* `is:repository-advisory`{% endif %}{% ifversion fpt or ghec %}
|
||||
* `is:discussion`{% endif %}
|
||||
|
||||
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts).
|
||||
|
||||
You can also use the `is:` query to describe how the notification was triaged.
|
||||
|
||||
* `is:saved`
|
||||
* `is:done`
|
||||
* `is:unread`
|
||||
* `is:read`
|
||||
|
||||
### Supported `reason:` queries
|
||||
|
||||
To filter notifications by why you've received an update, you can use the `reason:` query. For example, to see notifications when you (or a team you're on) is requested to review a pull request, use `reason:review-requested`. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications#reasons-for-receiving-notifications).
|
||||
|
||||
| Query | Description |
|
||||
|-----------------|-------------|
|
||||
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
|
||||
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
|
||||
| `reason:comment`| When you commented on an issue or pull request.
|
||||
| `reason:participating` | When you have commented on an issue or pull request or you have been @mentioned.
|
||||
| `reason:invitation` | When you're invited to a team, organization, or repository.
|
||||
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
|
||||
| `reason:mention` | You were directly @mentioned.
|
||||
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.
|
||||
| `reason:security-alert` | When a security alert is issued for a repository.
|
||||
| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged.
|
||||
| `reason:team-mention` | When a team you're a member of is @mentioned.
|
||||
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
### Supported `author:` queries
|
||||
|
||||
To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (for example: in an issue, pull request, gist, or discussion) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`.
|
||||
|
||||
### Supported `org:` queries
|
||||
|
||||
To filter notifications by organization, you can use the `org` query. The organization you need to specify in the query is the organization of the repository for which you are being notified on {% data variables.product.prodname_dotcom %}. This query is useful if you belong to several organizations, and want to see notifications for a specific organization.
|
||||
|
||||
For example, to see notifications from the octo-org organization, use `org:octo-org`.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## {% data variables.product.prodname_dependabot %} custom filters
|
||||
|
||||
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up to date, you can use and save these custom filters:
|
||||
* `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
|
||||
* `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
|
||||
* `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests.
|
||||
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).
|
||||
12
content/subscriptions-and-notifications/reference/index.md
Normal file
12
content/subscriptions-and-notifications/reference/index.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Reference for subscriptions and notifications
|
||||
shortTitle: Reference
|
||||
intro: 'Find information to use when managing your subscriptions and notifications on {% data variables.product.github %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /inbox-filters
|
||||
- /email-notification-headers
|
||||
---
|
||||
Reference in New Issue
Block a user