Skip to content

Commit

Permalink
[GHES 3.2] - Security Overview (versioning updates + improvements) (#…
Browse files Browse the repository at this point in the history
…20990)

* made required updates
  • Loading branch information
mchammer01 authored Aug 26, 2021
1 parent 1b46803 commit 1105d70
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 16 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/organizations/security-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For more information, see "[Managing security and analysis settings for your org
{% endif %}

## Next steps
{% ifversion fpt or ghae-next %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[Exploring security alerts](/code-security/security-overview/exploring-security-alerts)."{% endif %}
{% ifversion fpt or ghes > 3.1 or ghae-next %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."{% endif %}

You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes > 2.22 %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."

Expand Down
2 changes: 1 addition & 1 deletion content/code-security/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ includeGuides:
- /code-security/security-advisories/publishing-a-security-advisory
- /code-security/security-advisories/removing-a-collaborator-from-a-security-advisory
- /code-security/security-advisories/withdrawing-a-security-advisory
- /code-security/security-overview/exploring-security-alerts
- /code-security/security-overview/about-the-security-overview
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
---
title: Exploring security alerts
intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place.'
title: About the security overview
intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place: the Security Overview page.'
product: '{% data reusables.gated-features.security-center %}'
redirect_from:
- /code-security/security-overview/exploring-security-alerts
versions:
fpt: '*'
ghes: '>3.1'
ghae: next
type: how_to
topics:
Expand All @@ -12,7 +15,7 @@ topics:
- Alerts
- Organizations
- Teams
shortTitle: Explore security alerts
shortTitle: About security overview
---

{% data reusables.security-center.beta %}
Expand All @@ -21,13 +24,15 @@ shortTitle: Explore security alerts

You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)."

The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)."
The security overview indicates whether {% ifversion fpt or ghes > 3.1 %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %}

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. You can apply multiple filters to focus on 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 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 {% data variables.product.prodname_advanced_security %} feature and how many alerts there are of each type. If an {% data variables.product.prodname_advanced_security %} feature is not enabled for a repository, the icon for that feature will be grayed out.
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.

![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png)

Expand All @@ -36,12 +41,12 @@ For each repository in the security overview, you will see icons for each type o
| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." |
| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." |
| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." |
| {% octicon "check" aria-label="Check" %} | The {% data variables.product.prodname_advanced_security %} feature is enabled, but does not raise alerts in this repository. |
| {% octicon "x" aria-label="x" %} | The {% data variables.product.prodname_advanced_security %} feature is not supported in this repository. |
| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. |
| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. |

By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)."

The security overview displays active alerts raised by {% data variables.product.prodname_GH_advanced_security %} features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist.
The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist.

## Viewing the security overview for an organization

Expand All @@ -67,7 +72,7 @@ Members of a team can see the security overview for repositories that the team h

### Filter by level of risk for repositories

The level of risk for a repository is determined by the number and severity of alerts from {% data variables.product.prodname_advanced_security %} features. If one or more {% data variables.product.prodname_advanced_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 {% data variables.product.prodname_advanced_security %} features, the repository will have a clear level of risk.
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.

| Qualifier | Description |
| -------- | -------- |
Expand All @@ -85,7 +90,7 @@ The level of risk for a repository is determined by the number and severity of a
| <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. |

### Filter by whether {% data variables.product.prodname_advanced_security %} features are enabled
### Filter by whether security features are enabled

| Qualifier | Description |
| -------- | -------- |
Expand All @@ -99,8 +104,8 @@ The level of risk for a repository is determined by the number and severity of a
### Filter by repository type

| Qualifier | Description |
| -------- | -------- |
| `is:public` | Display public repositories. |
| -------- | -------- |{% ifversion fpt or ghes > 3.1 %}
| `is:public` | Display public repositories. |{% endif %}
| `is:internal` | Display internal repositories. |
| `is:private` | Display private repositories. |
| `archived:true` | Display archived repositories. |
Expand Down
2 changes: 1 addition & 1 deletion content/code-security/security-overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ topics:
- Security overview
- Advanced Security
children:
- /exploring-security-alerts
- /about-the-security-overview
---

2 changes: 1 addition & 1 deletion data/learning-tracks/code-security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ security_alerts:
title: 'Explore and manage security alerts'
description: 'Learn where to find and resolve security alerts.'
guides:
- /code-security/security-overview/exploring-security-alerts
- /code-security/security-overview/about-the-security-overview
- '{% ifversion fpt %}/code-security/secret-security/managing-alerts-from-secret-scanning {% endif %}'
- '{% ifversion fpt %}/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository{% endif %}'
- '{% ifversion fpt %}/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests{% endif %}'
Expand Down

0 comments on commit 1105d70

Please sign in to comment.