Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

repo sync #14251

Merged
merged 28 commits into from
Jan 18, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
b212f69
initial structural changes, new procedural doc and small additions
jules-p Dec 9, 2021
77d787b
building on about security overview content
jules-p Dec 15, 2021
a517663
Merge branch 'main' into jules-5503
jules-p Jan 4, 2022
b85cd92
repo view procedure, fixed format in filtering and more in about
jules-p Jan 4, 2022
891d7b1
fixes image ext and tweaks about section
jules-p Jan 4, 2022
7e74e51
Merge branch 'main' into jules-5503
jules-p Jan 4, 2022
12a6b6a
Update content/code-security/security-overview/about-the-security-ove…
jules-p Jan 5, 2022
1ad0604
Update content/code-security/security-overview/about-the-security-ove…
jules-p Jan 5, 2022
b9b3c90
Update content/code-security/security-overview/viewing-the-security-o…
jules-p Jan 5, 2022
c941ae2
bullet points sec overview for different locations
jules-p Jan 5, 2022
9bb545e
Update content/code-security/security-overview/about-the-security-ove…
jules-p Jan 5, 2022
4758fa2
adds links and removes duplicated permission info
jules-p Jan 5, 2022
c989268
Update content/code-security/security-overview/filtering-alerts-in-th…
jules-p Jan 5, 2022
484e7f7
restructures about article and fixes bugs in filtering article
jules-p Jan 6, 2022
c33ee1e
Merge branch 'jules-5503' of github.com:github/docs-internal into jul…
jules-p Jan 10, 2022
d04b507
incorporate Felicity's suggestions
jules-p Jan 11, 2022
0b7ff76
Merge branch 'main' into jules-5503
jules-p Jan 11, 2022
3da9795
deletes unused asset
jules-p Jan 11, 2022
afd2915
Merge branch 'jules-5503' of github.com:github/docs-internal into jul…
jules-p Jan 11, 2022
649263d
add severity filter and beta notice
jules-p Jan 12, 2022
5106e5e
Update content/code-security/security-overview/filtering-alerts-in-th…
jules-p Jan 13, 2022
0d02cfd
Merge branch 'main' into jules-5503
jules-p Jan 18, 2022
2007714
Merge branch 'main' into jules-5503
mattpollard Jan 18, 2022
9dfa19b
Adds GHES versioning to severity filter
jules-p Jan 18, 2022
8121418
Update filtering-alerts-in-the-security-overview.md
jules-p Jan 18, 2022
8336858
Update filtering-alerts-in-the-security-overview.md
jules-p Jan 18, 2022
a4b71d3
Merge branch 'main' into jules-5503
jules-p Jan 18, 2022
c465e0e
Merge pull request #23517 from github/jules-5503
jules-p Jan 18, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
restructures about article and fixes bugs in filtering article
  • Loading branch information
jules-p committed Jan 6, 2022
commit 484e7f78459594e670d38a375f741db5d3e00d0f
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,18 @@ The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %

For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)."

In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. The security summary is highly interactive, allowing you to investigate specific categories of information, based on qualifiers like alert risk level, alert type, and feature enablement. You can also apply multiple filters to focus on narrower areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts.
The application security team at your company can use the security overview for both broad and specific analyses of your organization's security status. For example, they can use the overview page to monitor adoption of features by your organization or by a specific team as you rollout {% data variables.product.prodname_GH_advanced_security %} to your enterprise, or to review all alerts of a specific type and severity level across all repositories in your organization.

### About filtering and sorting alerts

In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. The security summary is highly interactive, allowing you to investigate specific categories of information, based on qualifiers like alert risk level, alert type, and feature enablement. You can also apply multiple filters to focus on narrower areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. For more information, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."

{% ifversion ghec or ghes > 3.3 %}

In the security overview, at both the organization and repository level, there are dedicated views for specific security features, such as secret scanning alerts and code scanning alerts. You can use these views to limit your analysis to a specific set of alerts, and narrow the results further with a range of filters specific to each view. For example, in the secret scanning alert view, you can use the `Secret type` filter to view only secret scanning alerts for a specific secret, like a GitHub Personal Access Token. At the repository level, you can use the security overview to assess the specific repository's current security status, and configure any additional security features not yet in use on the repository.

{% endif %}

The application security team at your company can use the security overview for both broad and specific analyses of your organization's security status. For example, they can use the overview page to monitor adoption of features by your organization or by a specific team as you rollout {% data variables.product.prodname_GH_advanced_security %} to your enterprise, or to review all alerts of a specific type and severity level across all repositories in your organization.

![The security overview for an organization](/assets/images/help/organizations/security-overview.png)

For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ shortTitle: Filtering alerts

## About filtering the security overview

You can use filters in the security overview to narrow your focus based on a range of factors, like alert risk level, alert type and feature enablement. Different filters are available depending on the specific view and whether you analysing at the organization, team or repository level.

### Filter by level of risk for repositories

The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk.
Expand All @@ -35,20 +37,23 @@ The level of risk for a repository is determined by the number and severity of a

| Qualifier | Description |
| -------- | -------- |
| <code>code-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use &gt and &lt comparison operators. |
| <code>secret-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use &gt and &lt comparison operators. |
| <code>dependabot-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use &gt and &lt comparison operators. |
| <code>code-scanning:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use &gt and &lt comparison operators. |
| <code>secret-scanning:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use &gt and &lt comparison operators. |
| <code>dependabot:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use &gt and &lt comparison operators. |
| <code>dependabot:<em>>=10</em></code> | |

### Filter by whether security features are enabled

| Qualifier | Description |
| -------- | -------- |
| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. |
| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. |
| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. |
| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. |
| `code-scanning:enabled` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. |
| `code-scanning:not-enabled` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. |
| `secret-scanning:enabled` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
| `secret-scanning:not-enabled` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
| `dependabot-alerts:enabled` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. |
| `dependabot-alerts:not-enabled` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. |
| `not-enabled:any` | Display repositories with at least one security feature that is not enabled. |


### Filter by repository type

Expand Down Expand Up @@ -90,7 +95,7 @@ The level of risk for a repository is determined by the number and severity of a

| Qualifier | Description |
| -------- | -------- |
| `repository:REPOSITORY-NAME` | Displays alerts for the specified repository. |
| `repo:REPOSITORY-NAME` | Displays alerts for the specified repository. |

### Filter by secret types

Expand Down