Skip to content

Commit 970b66a

Browse files
felicitymaysophiethekingpallsamaisaacmbrownmchammer01
authored
GHES 3.15 minor updates for security features: versioning and enterprise CodeQL PR alerts view (#52905)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Pallavi <96553709+pallsama@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: isaacmbrown <isaacmbrown@github.com> Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com> Co-authored-by: Hector Alfaro <hectorsector@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
1 parent 26372cf commit 970b66a

File tree

4 files changed

+37
-8
lines changed

4 files changed

+37
-8
lines changed

content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Viewing metrics for pull request alerts
33
shortTitle: View PR alert metrics
44
allowTitleToDifferFromFilename: true
5-
intro: 'You can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests for repositories across your organization, and to identify repositories where you may need to take action.'
5+
intro: 'You can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests for repositories across your organizations, and to identify repositories where you may need to take action.'
66
permissions: '{% data reusables.permissions.security-overview %}'
77
type: how_to
88
topics:
@@ -16,26 +16,36 @@ versions:
1616
feature: security-overview-org-codeql-pr-alerts
1717
---
1818

19-
## About {% data variables.product.prodname_codeql %} pull request alerts metrics for an organization
19+
## About {% data variables.product.prodname_codeql %} pull request alerts metrics
2020

21-
The metrics overview for {% data variables.product.prodname_codeql %} pull request alerts helps you to understand how well {% data variables.product.prodname_codeql %} is preventing vulnerabilities in your organization. You can use the metrics to assess how {% data variables.product.prodname_codeql %} is performing in pull requests, and to easily identify the repositories where you may need to take action in order to identify and reduce security risks.
21+
The metrics overview for {% data variables.product.prodname_codeql %} pull request alerts helps you to understand how well {% data variables.product.prodname_codeql %} is preventing vulnerabilities in your organizations. You can use the metrics to assess how {% data variables.product.prodname_codeql %} is performing in pull requests, and to easily identify the repositories where you may need to take action in order to identify and reduce security risks.
2222

23-
The overview shows you a summary of how many vulnerabilities prevented by {% data variables.product.prodname_codeql %} have been caught in pull requests. The metrics are only tracked for pull requests that have been merged into the default branches of repositories in your organization.
23+
The overview shows you a summary of how many vulnerabilities prevented by {% data variables.product.prodname_codeql %} have been caught in pull requests. The metrics are only tracked for pull requests that have been merged into the default branches of repositories in your organizations.
2424

25-
You can also find more granular metrics, such as how many alerts were fixed with and without {% data variables.product.prodname_copilot_autofix_short %} suggestions, how many were unresolved and merged, and how many were dismissed as false positive or as risk accepted.
25+
You can also find more granular metrics, such as how many alerts were fixed{% ifversion code-scanning-autofix %} with and without {% data variables.product.prodname_copilot_autofix_short %} suggestions{% endif %}, how many were unresolved and merged, and how many were dismissed as false positive or as risk accepted.
2626

2727
You can also view:
2828

29-
* The rules that are causing the most alerts in your organization, and how many alerts each rule is associated with.
29+
* The rules that are causing the most alerts, and how many alerts each rule is associated with.
3030

31+
* The number of alerts that were merged into the default branch without resolution, and the number of alerts dismissed as an acceptable risk.
32+
33+
{% ifversion code-scanning-autofix %}
3134
* The number of alerts that were fixed with an accepted {% data variables.product.prodname_copilot_autofix_short %} suggestion, displayed as a fraction of how many total {% data variables.product.prodname_copilot_autofix_short %} suggestions were available.
3235

3336
* Remediation rates, in a graph showing the percentage of alerts that were remediated with an available {% data variables.product.prodname_copilot_autofix_short %} suggestion, and the percentage of alerts that were remediated without a {% data variables.product.prodname_copilot_autofix_short %} suggestion.
37+
{% endif %}
3438

3539
You can apply filters to the data. The metrics are based on activity from the default period or your selected period.
3640

3741
![Screenshot of the "CodeQL pull request alerts" view for an organization, showing status and trends over 90 days.](/assets/images/help/security-overview/security-overview-codeql-pull-requests-alerts-report.png)
3842

43+
{% ifversion code-scanning-autofix %}
44+
> [!NOTE] Metrics for {% data variables.product.prodname_copilot_autofix_short %} will be shown only for repositories where {% data variables.product.prodname_copilot_autofix_short %} is enabled.
45+
{% else %}
46+
> [!NOTE] Metrics for {% data variables.product.prodname_copilot_autofix_short %} are omitted because {% data variables.product.prodname_copilot_autofix_short %} is available only on {% data variables.product.github %} cloud platforms.
47+
{% endif %}
48+
3949
## Viewing {% data variables.product.prodname_codeql %} pull request alerts metrics for an organization
4050

4151
{% data reusables.organizations.navigate-to-org %}
@@ -49,3 +59,17 @@ You can apply filters to the data. The metrics are based on activity from the de
4959
* To search for repositories matching the selected filter, fill out the available fields for that filter, then click **Apply**. You can repeat this process to add as many filters as you would like to your search.
5060
* Optionally, to remove a filter from your search, click {% octicon "filter" aria-hidden="true" %} **Filter**. In the row of the filter you want to remove, click {% octicon "x" aria-label="Delete FILTER-NUMBER: FILTER-PROPERTIES" %}, then click **Apply**.{% ifversion security-overview-export-data %}
5161
1. You can use the {% octicon "download" aria-hidden="true" %} **Export CSV** button to download a CSV file of the data currently displayed on the page for security research and in-depth data analysis. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview)." {% endif %}
62+
63+
{% ifversion security-overview-enterprise-codeql-pr-alerts %}
64+
65+
## Viewing {% data variables.product.prodname_codeql %} pull request alerts metrics for your enterprise
66+
67+
You can also view metrics for {% data variables.product.prodname_codeql %} alerts in pull requests across organizations in your enterprise.
68+
69+
{% data reusables.security-overview.enterprise-filters-tip %}
70+
71+
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
72+
{% data reusables.code-scanning.click-code-security-enterprise %}
73+
1. In the sidebar, under "Metrics", click **{% octicon "graph" aria-hidden="true" %} {% data variables.product.prodname_codeql %} pull request alerts**.
74+
75+
{% endif %}

data/features/enforce-security-configurations.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
versions:
33
fpt: '*'
44
ghec: '*'
5-
ghes: '>= 3.14'
5+
ghes: '>= 3.15'
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reference: #14348
2+
# Documentation for enterprise-level CodeQL PR alerts report
3+
versions:
4+
ghes: '> 3.14'
5+
ghec: '*'

data/features/security-overview-org-codeql-pr-alerts.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Reference: #4347
1+
# Reference: #14347
22
# Documentation for org-level CodeQL PR alerts report
33
versions:
44
ghes: '> 3.14'

0 commit comments

Comments
 (0)