Skip to content

Commit aa61644

Browse files
authored
Merge pull request #26026 from github/repo-sync
Repo sync
2 parents 55a4386 + 4a4b557 commit aa61644

13 files changed

Lines changed: 105 additions & 30 deletions
202 KB
Loading
150 KB
Loading
209 KB
Loading

content/code-security/security-overview/about-security-overview.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,15 @@ Each repository is shown in security overview with an indicator for each type of
8989
{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}
9090
## About security overview for enterprises
9191

92-
You can find security overview on the **Code Security** tab for your enterprise. Each page displays aggregated and repository-specific security information for your enterprise. You can view repositories owned by your enterprise that have security alerts, view all security alerts, or security feature-specific alerts from across your enterprise.
92+
You can find security overview on the **Code Security** tab for your enterprise. Each page displays aggregated and repository-specific security information for your enterprise. {% ifversion security-overview-org-risk-coverage-enterprise %}
9393

94-
Enterprise owners can view alerts for organizations that they are an owner or a security manager of.{% ifversion ghec or ghes > 3.5 or ghae > 3.5 %} Enterprise owners will need to join an organization as an organization owner to see all of its alerts in the enterprise-level security overview. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."{% endif %}
94+
As with security overview for organizations, security overview for enterprises has multiple views that provide different ways to explore enablement and alert data.
9595

96+
- Use the "Security coverage" view to assess the adoption of code security features across organizations in the enterprise.
97+
- Use the "Security risk" view to assess the risk from security alerts of all types across organizations in the enterprise.
98+
- Use the individual security alert views to identify your risk from specific vulnerable dependencies, code weaknesses, or leaked secrets.{% else %}You can view repositories owned by your enterprise that have security alerts, view all security alerts, or view security feature-specific alerts from across your enterprise.{% endif %}
99+
100+
For information about permissions, see "[Permission to view data in security overview](#permission-to-view-data-in-security-overview)."
96101

97102
{% endif %}
98103

@@ -109,9 +114,11 @@ At the team level, security overview displays repository-specific security infor
109114

110115
## Permission to view data in security overview
111116

112-
If you are an owner or security manager for an organization, you will see data for all the repositories in the organization in all views.
117+
If you are an owner or security manager for an organization, you can see data for all the repositories in the organization in all views.{% ifversion security-overview-org-risk-coverage-enterprise %} You can see the data in the organization-level security overview, or see data for all organizations where you are an owner or security manager in the enterprise-level security overview.{% endif %}
118+
119+
{% ifversion ghec or ghes > 3.5 or ghae > 3.5 %}If you are an enterprise owner, you will need to join an organization as an organization owner to view data for the organization's repositories in either the organization-level or enterprise-level overview. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."{% endif %}
113120

114-
If you are an organization member, you will see data only where you have access to that data at the repository level.
121+
If you are an organization member, you can view security overview for the organization and see data for repositories where you have access.{% ifversion security-overview-org-risk-coverage-enterprise %} You can view this data in the organization-level overview, but you cannot access the enterprise-level overview.{% endif %}
115122

116123
{% rowheaders %}
117124

content/code-security/security-overview/assessing-adoption-code-security.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,45 @@ You can use security overview to see which repositories and teams have already e
2424

2525
![Screenshot of the header section of the "Security coverage" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "enabled" and "not enabled" links, "Teams" selector, and search field.](/assets/images/help/security-overview/security-coverage-view-summary.png)
2626

27-
## Viewing the enablement of code security features across repositories
27+
## Viewing the enablement of code security features for an organization
2828

29-
{% data reusables.security-overview.information-varies-GHAS %} For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview)."
29+
{% data reusables.security-overview.information-varies-GHAS %}
3030

3131
{% data reusables.organizations.navigate-to-org %}
3232
{% data reusables.organizations.security-overview %}
3333
1. To display the "Security coverage" view, in the sidebar, click **{% octicon "meter" aria-hidden="true" %} Coverage**.
34-
1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."
35-
- Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)."
36-
- Click **NUMBER enabled** or **NUMBER not enabled** in the header for any feature to show only the repositories with that feature enabled or not enabled.
37-
- At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived.
38-
- Click in the search box to add further filters to the repositories displayed.
39-
40-
![Screenshot of the header section of the "Security coverage" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "enabled" and "not enabled" links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-coverage-view-highlights.png)
34+
{% data reusables.code-scanning.using-security-overview-coverage %}
4135

36+
![Screenshot of the header section of the "Security coverage" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "enabled" and "not enabled" links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-coverage-view-highlights.png)
37+
4238
1. Optionally, click **{% octicon "gear" aria-hidden="true" %} Security settings** to enable code security features for a repository and click **Save security settings** to confirm the changes. If a feature is not shown, it has more complex configuration requirements and you need to use the repository settings dialog. For more information, see "[AUTOTITLE](/code-security/getting-started/securing-your-repository)."
4339
{% ifversion code-security-multi-repo-enablement %}
4440
1. Optionally, select some or all of the repositories that match your current search and click **Security settings** in the table header to display a side panel where you can enable security features for the selected repositories. When you've finished, click **Apply changes** to confirm the changes. For more information, see "[AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories)."
4541
{% endif %}
42+
43+
{% ifversion security-overview-org-risk-coverage-enterprise %}
44+
45+
## Viewing the enablement of code security features for an enterprise
46+
47+
You can view data to assess the enablement of code security features across organizations in an enterprise. {% data reusables.security-overview.information-varies-GHAS %}
48+
49+
In the enterprise-level view, you can view data about the enablement of features, but you cannot enable or disable features. For more information about enabling features, see "[AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories)."
50+
51+
{% tip %}
52+
53+
**Tip:** You can use the `org:` filter in the search field to filter the data by organization. For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."
54+
55+
{% endtip %}
56+
57+
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
58+
{% data reusables.code-scanning.click-code-security-enterprise %}
59+
1. To display the "Security coverage" view, in the sidebar, click **Coverage**.
60+
{% data reusables.code-scanning.using-security-overview-coverage %}
61+
62+
![Screenshot of the header section of the "Security coverage" view for an enterprise. The options for filtering are outlined in dark orange, including "enabled" and "not enabled" links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-coverage-view-highlights-enterprise.png)
63+
64+
{% endif %}
65+
4666
## Interpreting and acting on the enablement data
4767

4868
Some code security features can and should be enabled on all repositories. For example, secret scanning alerts and push protection. These features reduce the risk of a security leak no matter what information is stored in the repository. If you see repositories that don't already use these features, you should either enable them or discuss an enablement plan with the team who owns the repository. For information on enabling features for a whole organization, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)."

content/code-security/security-overview/assessing-code-security-risk.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ redirect_from:
2828

2929
## About security risks in your code
3030

31-
You can use security overview to see which repositories and teams are free from any security alerts and which have unresolved security alerts. The "Security risk" page shows a summary and detailed information on which repositories in an organization are affected by security alerts, with a breakdown of alert by severity. You can filter the view to show a subset of repositories using the "affected" and "unaffected" links, the links under "Open alerts", the "Teams" dropdown menu, and a search field in the page header. This view is a great way to understand the broader picture for a repository, team, or group of repositories because you can see security alerts of all types in one view.
31+
You can use security overview to see which repositories and teams are free from any security alerts and which have unresolved security alerts. The "Security risk" page shows a summary and detailed information on which repositories in an organization {% ifversion security-overview-org-risk-coverage-enterprise %}or enterprise {% endif %}are affected by security alerts, with a breakdown of alert by severity. You can filter the view to show a subset of repositories using the "affected" and "unaffected" links, the links under "Open alerts", the "Teams" dropdown menu, and a search field in the page header. This view is a great way to understand the broader picture for a repository, team, or group of repositories because you can see security alerts of all types in one view.
3232

3333
![Screenshot of the header section of the "Security risk" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "affected"/"unaffected" links, "Teams" selector, and search field.](/assets/images/help/security-overview/security-risk-view-summary.png)
3434

@@ -40,22 +40,16 @@ You can use security overview to see which repositories and teams are free from
4040

4141
## Viewing organization-level code security risks
4242

43-
{% data reusables.security-overview.information-varies-GHAS %} For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview)."
44-
43+
{% data reusables.security-overview.information-varies-GHAS %}
4544

4645
{% ifversion security-overview-org-risk-coverage %}
4746

4847
{% data reusables.organizations.navigate-to-org %}
4948
{% data reusables.organizations.security-overview %}
5049
1. To display the "Security risk" view, in the sidebar, click **{% octicon "shield" aria-hidden="true" %} Risk**.
51-
1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."
52-
- Use the **Teams** dropdown to show information only for the repositories owned by one or more teams.
53-
- Click **NUMBER affected** or **NUMBER unaffected** in the header for any feature to show only the repositories with open alerts or no open alerts of that type.
54-
- Click any of the descriptions of "Open alerts" in the header to show only repositories with alerts of that type and category. For example, **1 critical** to show the repository with a critical alert for {% data variables.product.prodname_dependabot %}.
55-
- At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived.
56-
- Click in the search box to add further filters to the repositories displayed.
50+
{% data reusables.code-scanning.using-security-overview-risk %}
5751

58-
![Screenshot of the header section of the "Security risk" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "affected"/"unaffected" links, alert severity links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-risk-view-highlights.png)
52+
![Screenshot of the header section of the "Security risk" view on the "Security" tab for an organization. The options for filtering are outlined in dark orange, including "affected"/"unaffected" links, alert severity links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-risk-view-highlights.png)
5953

6054
{% data reusables.organizations.security-overview-feature-specific-page %}
6155

@@ -76,10 +70,26 @@ You can use security overview to see which repositories and teams are free from
7670

7771
## Viewing enterprise-level code security risks
7872

73+
{% ifversion security-overview-org-risk-coverage-enterprise %}
74+
75+
You can view data for security alerts across organizations in an enterprise. {% data reusables.security-overview.information-varies-GHAS %}
76+
77+
{% tip %}
78+
79+
**Tip:** You can use the `org:` filter in the search field to filter the data by organization. For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."
80+
81+
{% endtip %}
82+
83+
{% endif %}
84+
7985
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
80-
1. In the left sidebar, click **{% octicon "shield" aria-hidden="true" %} Code Security**.
81-
{% ifversion security-overview-feature-specific-alert-page %}
82-
{% data reusables.organizations.security-overview-feature-specific-page %}
86+
{% data reusables.code-scanning.click-code-security-enterprise %}
87+
{% ifversion security-overview-feature-specific-alert-page %}{% ifversion security-overview-org-risk-coverage-enterprise %}
88+
1. To display the "Security coverage" view, in the sidebar, click **Risk**.
89+
{% data reusables.code-scanning.using-security-overview-risk %}
90+
91+
![Screenshot of the "Security risk" view for an enterprise. The options for filtering are outlined in dark orange, including "affected"/"unaffected" links, alert severity links, "Teams" selector, archived repositories, and search field.](/assets/images/help/security-overview/security-risk-view-highlights-enterprise.png){% else %}
92+
{% data reusables.organizations.security-overview-feature-specific-page %}{% endif %}
8393
{% endif %}
8494

8595
{% endif %}

content/code-security/security-overview/enabling-security-features-for-multiple-repositories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ topics:
2222

2323
## About enabling security features
2424

25-
If you're a security manager, repository administrator, or organization owner, you can use security overview to enable or disable security features for multiple repositories at the same time. You can enable or disable security features for all repositories visible on the "Security coverage" view in security overview. You can also use the search bar to narrow down to a specific subset of repositories, and enable or disable security features for that group.
25+
If you're a security manager, repository administrator, or organization owner, you can use security overview to enable or disable security features for multiple repositories at the same time. You can enable or disable security features for all repositories visible on the "Security coverage" view in security overview for an organization. You can also use the search bar to narrow down to a specific subset of repositories, and enable or disable security features for that group.
2626

2727
## Enabling security features for multiple repositories
2828

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

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,18 @@ To perform an exact search for a single repository, use the `repo` qualifier. If
4444
| -------- | -------- |
4545
| `repo:REPOSITORY-NAME` | Displays data for the specified repository. |
4646

47+
{% ifversion security-overview-org-risk-coverage-enterprise %}
48+
49+
## Filter by organization
50+
51+
In the enterprise-level views, you can filter the data by organization.
52+
53+
| Qualifier | Description |
54+
| -------- | -------- |
55+
| `org:ORGANIZATION-NAME` | Displays data for the specified organization. |
56+
57+
{% endif %}
58+
4759
## Filter by whether security features are enabled
4860

4961
In the examples below, replace `:enabled` with `:not-enabled` to see repositories where security features are not enabled. These qualifiers are available in the main summary views.
@@ -83,7 +95,7 @@ These qualifiers are available in the main summary views.
8395
| `archived:true` | Display archived repositories. |
8496
| `archived:false` | Omit archived repositories. |
8597

86-
{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}
98+
{% ifversion security-overview-org-risk-coverage-enterprise %}{% else %}
8799
## Filter by level of risk for repositories
88100

89101
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.
@@ -103,7 +115,15 @@ These qualifiers are available in the enterprise-level view.
103115

104116
## Filter by number of alerts
105117

106-
{% ifversion security-overview-org-risk-coverage %}These qualifiers are available in the enterprise-level "Overview" and in the organization-level "Security risk" view.{% else %}These qualifiers are available in the main summary views.{% endif %}
118+
{% ifversion security-overview-org-risk-coverage %}
119+
120+
These qualifiers are available in the{% ifversion security-overview-org-risk-coverage-enterprise %}{% else %} enterprise-level "Overview" and in the organization-level{% endif %} "Security risk" view.
121+
122+
{% else %}
123+
124+
These qualifiers are available in the main summary views.
125+
126+
{% endif %}
107127

108128
| Qualifier | Description |
109129
| -------- | -------- |
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reference: #10312
2+
# Documentation for the enterprise-level security "Risk" and "Coverage" views
3+
versions:
4+
ghes: '> 3.9'
5+
ghec: '*'
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1. In the left sidebar, click **{% octicon "shield" aria-hidden="true" %} Code Security**.

0 commit comments

Comments
 (0)