Skip to content

Commit 026075a

Browse files
Update filters in "Filtering alerts in security overview" (github#36814)
Co-authored-by: Laura Coursen <[email protected]>
1 parent 049f094 commit 026075a

File tree

2 files changed

+75
-18
lines changed

2 files changed

+75
-18
lines changed

content/code-security/security-overview/filtering-alerts-in-security-overview.md

Lines changed: 69 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ You can use filters in a security overview to narrow your focus based on a range
3636

3737
## Filter by repository
3838

39+
Security overview supports free text search for repositories. With free text search, you can search for a keyword, and repositories with names containing that keyword will be displayed. For example, if you search for "test", your search results would include both "test-repository" and "octocat-testing".
40+
41+
To perform an exact search for a single repository, use the `repo` qualifier. If you do not type the name of the repository exactly as it appears, the repository will not be found.
42+
3943
| Qualifier | Description |
4044
| -------- | -------- |
4145
| `repo:REPOSITORY-NAME` | Displays data for the specified repository. |
@@ -103,9 +107,9 @@ These qualifiers are available in the enterprise-level view.
103107

104108
| Qualifier | Description |
105109
| -------- | -------- |
106-
| `code-scanning:NUMBER` | Display repositories that have NUMBER {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use `=`, `>` and `<` comparison operators. |
107-
| `secret-scanning:NUMBER` | Display repositories that have NUMBER {% data variables.secret-scanning.alerts %}. This qualifier can use `=`, `>` and `<` comparison operators. |
108-
| `dependabot:NUMBER` | Display repositories that have NUMBER {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use `=`, `>` and `<` comparison operators. |
110+
| `code-scanning-alerts:NUMBER` | Display repositories that have NUMBER {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use `=`, `>` and `<` comparison operators. |
111+
| `secret-scanning-alerts:NUMBER` | Display repositories that have NUMBER {% data variables.secret-scanning.alerts %}. This qualifier can use `=`, `>` and `<` comparison operators. |
112+
| `dependabot-alerts:NUMBER` | Display repositories that have NUMBER {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use `=`, `>` and `<` comparison operators. |
109113

110114
## Filter by team
111115

@@ -123,6 +127,41 @@ These qualifiers are available in the main summary views{% ifversion security-ov
123127
| -------- | -------- |
124128
| `topic:TOPIC-NAME` | Displays repositories that are classified with TOPIC-NAME. For more information on repository topics, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)." |
125129

130+
{% ifversion security-overview-dependabot-acv %}
131+
132+
## Additional filters for {% data variables.product.prodname_dependabot %} alert views
133+
134+
You can filter the view to show {% data variables.product.prodname_dependabot_alerts %} that are ready to fix or where additional information about exposure is available. You can click any result to see full details of the alert.
135+
136+
| Qualifier | Description |
137+
| -------- | -------- |
138+
{% ifversion dependabot-alerts-vulnerable-calls or ghes > 3.5 or ghae > 3.5 -%}
139+
|`has:patch`|Displays {% data variables.product.prodname_dependabot %} alerts for vulnerabilities where a secure version is already available.|
140+
|`has:vulnerable-calls`|Displays {% data variables.product.prodname_dependabot %} alerts where at least one call from the repository to a vulnerable function is detected. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#about-the-detection-of-calls-to-vulnerable-functions)."|
141+
{% endif -%}
142+
|`ecosystem:ECOSYSTEM-NAME`|Displays {% data variables.product.prodname_dependabot_alerts %} detected in the specified ecosystem.|
143+
|`is:open`|Displays open {% data variables.product.prodname_dependabot_alerts %}.|
144+
|`is:closed`|Displays closed {% data variables.product.prodname_dependabot_alerts %}.|
145+
|`package:PACKAGE-NAME`|Displays {% data variables.product.prodname_dependabot_alerts %} detected in the specified package.|
146+
{% ifversion security-overview-alert-views -%}
147+
|`resolution:auto-dismissed`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "auto-dismissed."|
148+
|`resolution:fix-started`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "a fix has already been started."|
149+
|`resolution:fixed`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "fixed."|
150+
|`resolution:inaccurate`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "this alert is inaccurate or incorrect."|
151+
|`resolution:no-bandwidth`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "no bandwidth to fix this."|
152+
|`resolution:not-used`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "vulnerable code is not actually used."|
153+
|`resolution:tolerable-risk`|Displays {% data variables.product.prodname_dependabot_alerts %} closed as "risk is tolerable to this project."|
154+
|`scope:development`|Displays {% data variables.product.prodname_dependabot_alerts %} from the development dependency.|
155+
|`scope:runtime`|Displays {% data variables.product.prodname_dependabot_alerts %} from the runtime dependency.|
156+
{% endif -%}
157+
|`sort:manifest-path`|Displays {% data variables.product.prodname_dependabot_alerts %} grouped by the manifest file path the alerts point to.|
158+
|`sort:most-important`|Displays {% data variables.product.prodname_dependabot_alerts %} from most important to least important, as determined by CVSS score, vulnerability impact, relevancy, and actionability.|
159+
|`sort:newest`|Displays {% data variables.product.prodname_dependabot_alerts %} from newest to oldest.|
160+
|`sort:oldest`|Displays {% data variables.product.prodname_dependabot_alerts %} from oldest to newest.|
161+
|`sort:package-name`|Displays {% data variables.product.prodname_dependabot_alerts %} grouped by the package in which the alert was detected.|
162+
|`sort:severity`|Displays {% data variables.product.prodname_dependabot_alerts %} from most to least severe.
163+
{% endif %}
164+
126165
{% ifversion security-overview-alert-views %}
127166

128167
## Additional filters for {% data variables.product.prodname_code_scanning %} alert views
@@ -131,33 +170,45 @@ All code scanning alerts have one of the categories shown below. You can click a
131170

132171
| Qualifier | Description |
133172
| -------- | -------- |
173+
|`is:open`|Displays open {% data variables.product.prodname_code_scanning %} alerts.|
174+
|`is:closed`|Displays closed {% data variables.product.prodname_code_scanning %} alerts.|
175+
|`resolution:false-positive`|Displays {% data variables.product.prodname_code_scanning %} alerts closed as "false positive."|
176+
|`resolution:fixed`|Displays {% data variables.product.prodname_code_scanning %} alerts closed as "fixed."|
177+
|`resolution:used-in-tests`|Displays {% data variables.product.prodname_code_scanning %} alerts closed as "used in tests."|
178+
|`resolution:wont-fix`|Displays {% data variables.product.prodname_code_scanning %} alerts closed as "won't fix."|
179+
|`rule:RULE-NAME`|Displays {% data variables.product.prodname_code_scanning %} alerts opened for the specified rule.|
134180
|`severity:critical`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as critical.|
135181
|`severity:high`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as high.|
136182
|`severity:medium`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as medium.|
137183
|`severity:low`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as low.|
138184
|`severity:error`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as errors.|
139185
|`severity:warning`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as warnings.|
140186
|`severity:note`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as notes.|
141-
142-
{% ifversion dependabot-alerts-vulnerable-calls %}
143-
## Additional filters for {% data variables.product.prodname_dependabot %} alert views
144-
145-
You can filter the view to show {% data variables.product.prodname_dependabot_alerts %} that are ready to fix or where additional information about exposure is available. You can click any result to see full details of the alert.
146-
147-
| Qualifier | Description |
148-
| -------- | -------- |
149-
|`has:patch`|Displays {% data variables.product.prodname_dependabot %} alerts for vulnerabilities where a secure version is already available.|
150-
|`has:vulnerable-calls`|Displays {% data variables.product.prodname_dependabot %} alerts where at least one call from the repository to a vulnerable function is detected. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#about-the-detection-of-calls-to-vulnerable-functions)."|
151-
{% endif %}
152-
153-
{% endif %}
187+
|`sort:created-desc`|Displays {% data variables.product.prodname_code_scanning %} alerts from newest to oldest.|
188+
|`sort:created-asc`|Displays {% data variables.product.prodname_code_scanning %} alerts from oldest to newest.|
189+
|`sort:updated-desc`|Displays {% data variables.product.prodname_code_scanning %} alerts from most recently updated to least recently updated.|
190+
|`sort:updated-asc`|Displays {% data variables.product.prodname_code_scanning %} alerts from least recently updated to most recently updated.|
191+
|`tool:TOOL-NAME`|Displays {% data variables.product.prodname_code_scanning %} alerts detected by the specified tool.|
154192

155193
## Additional filters for {% data variables.product.prodname_secret_scanning %} alert views
156194

157195
| Qualifier | Description |
158196
| -------- | -------- |
159-
|`provider:PROVIDER_NAME` | Displays alerts for all secrets issues by the specified provider. |
160-
| `secret-type:SERVICE_PROVIDER` | Displays alerts for the specified secret and provider. |
197+
|`provider:PROVIDER-NAME` | Displays alerts for all secrets issues by the specified provider. |
198+
| `secret-type:PROVIDER-PATTERN` | Displays alerts for the specified secret and provider. |
161199
| `secret-type:CUSTOM-PATTERN` | Displays alerts for secrets matching the specified custom pattern. |
200+
|`is:open`|Displays open {% data variables.product.prodname_secret_scanning %} alerts.|
201+
|`is:closed`|Displays closed {% data variables.product.prodname_secret_scanning %} alerts.|
202+
|`resolution:false-positive`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "false positive."|
203+
|`resolution:pattern-deleted`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "pattern deleted."|
204+
|`resolution:pattern-edited`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "pattern edited."|
205+
|`resolution:revoked`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "revoked."|
206+
|`resolution:used-in-tests`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "used in tests."|
207+
|`resolution:wont-fix`|Displays {% data variables.product.prodname_secret_scanning %} alerts closed as "won't fix."|
208+
|`sort:created-desc`|Displays {% data variables.product.prodname_secret_scanning %} alerts from newest to oldest.|
209+
|`sort:created-asc`|Displays {% data variables.product.prodname_secret_scanning %} alerts from oldest to newest.|
210+
|`sort:updated-desc`|Displays {% data variables.product.prodname_secret_scanning %} alerts from most recently updated to least recently updated.|
211+
|`sort:updated-asc`|Displays {% data variables.product.prodname_secret_scanning %} alerts from least recently updated to most recently updated.|
162212

163213
For more information, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-patterns)."
214+
{% endif %}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reference: comment in PR #36814
2+
3+
versions:
4+
ghec: '*'
5+
ghes: '> 3.3'
6+
ghae: '> 3.3'

0 commit comments

Comments
 (0)