Skip to content

Commit afccd33

Browse files
authored
Merge pull request #17223 from github/2845-new-notification-filters
New filters for notifications (GA)
2 parents aa7684c + 35bb42f commit afccd33

4 files changed

Lines changed: 67 additions & 22 deletions

File tree

content/github/administering-a-repository/about-dependabot-version-updates.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,7 @@ You can configure version updates for repositories that contain a dependency man
4444
{% data reusables.dependabot.supported-package-managers %}
4545

4646
If your repository already uses an integration for dependency management, you will need to disable this before enabling {% data variables.product.prodname_dependabot %}. For more information, see "[About integrations](/github/customizing-your-github-workflow/about-integrations)."
47+
48+
### About notifications for {% data variables.product.prodname_dependabot %} version updates
49+
50+
You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} version updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)."

content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,7 @@ When you merge a pull request that contains a security update, the corresponding
3333
### About compatibility scores
3434

3535
{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a vulnerability could cause breaking changes to your project. These are calculated from CI tests in other public repositories where the same security update has been generated. An update's compatibility score is the percentage of CI runs that passed when updating between specific versions of the dependency.
36+
37+
### About notifications for {% data variables.product.prodname_dependabot %} security updates
38+
39+
You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)."

content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You can configure notification settings for yourself or your organization from t
4040

4141
{% note %}
4242

43-
**Note:** You can filter your {% data variables.product.company_short %} inbox notifications to show {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-queries-for-custom-filters)."
43+
**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)."
4444

4545
{% endnote %}
4646

content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md

Lines changed: 58 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -90,31 +90,16 @@ Custom filters do not currently support:
9090

9191
### Supported queries for custom filters
9292

93-
There are three types of filters that you can use:
93+
These are the types of filters that you can use:
9494
- Filter by repository with `repo:`
9595
- Filter by discussion type with `is:`
96-
- Filter by notification reason with `reason:`
96+
- Filter by notification reason with `reason:`{% if currentVersion == "free-pro-team@latest" %}
97+
- Filter by notification author with `author:`
98+
- Filter by organization with `org:`{% endif %}
9799

98-
To add a `repo:` filter, you must include the owner of the repository in the query. For example, `repo:atom/atom` represents the Atom repository owned by the Atom organization.
100+
#### Supported `repo:` queries
99101

100-
#### Supported `reason:` queries
101-
102-
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 "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)."
103-
104-
| Query | Description |
105-
|-----------------|-------------|
106-
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
107-
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
108-
| `reason:comment`| When you commented on an issue, pull request, or team discussion.
109-
| `reason:participating` | When you have commented on an issue, pull request, or team discussion or you have been @mentioned.
110-
| `reason:invitation` | When you're invited to a team, organization, or repository.
111-
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
112-
| `reason:mention` | You were directly @mentioned.
113-
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% if currentVersion != "github-ae@latest" %}
114-
| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
115-
| `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.
116-
| `reason:team-mention` | When a team you're a member of is @mentioned.
117-
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
102+
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.
118103

119104
#### Supported `is:` queries
120105

@@ -141,3 +126,55 @@ You can also use the `is:` query to describe how the notification was triaged.
141126
- `is:done`
142127
- `is:unread`
143128
- `is:read`
129+
130+
#### Supported `reason:` queries
131+
132+
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 "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)."
133+
134+
| Query | Description |
135+
|-----------------|-------------|
136+
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
137+
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
138+
| `reason:comment`| When you commented on an issue, pull request, or team discussion.
139+
| `reason:participating` | When you have commented on an issue, pull request, or team discussion or you have been @mentioned.
140+
| `reason:invitation` | When you're invited to a team, organization, or repository.
141+
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
142+
| `reason:mention` | You were directly @mentioned.
143+
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% if currentVersion != "github-ae@latest" %}
144+
| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
145+
| `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.
146+
| `reason:team-mention` | When a team you're a member of is @mentioned.
147+
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
148+
149+
{% if currentVersion == "free-pro-team@latest" %}
150+
#### Supported `author:` queries
151+
152+
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`.
153+
154+
#### Supported `org:` queries
155+
156+
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.
157+
158+
For example, to see notifications from the octo-org organization, use `org:octo-org`.
159+
160+
{% endif %}
161+
162+
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
163+
### {% data variables.product.prodname_dependabot %} custom filters
164+
165+
{% if currentVersion == "free-pro-team@latest" %}
166+
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters:
167+
- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
168+
- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
169+
- `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.
170+
171+
For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)."
172+
{% endif %}
173+
174+
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
175+
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save the `is:repository_vulnerability_alert` custom filter to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
176+
177+
For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
178+
{% endif %}
179+
180+
{% endif %}

0 commit comments

Comments
 (0)