Skip to content

Commit 354d907

Browse files
sabrowning1Copilotlecoursen
authored
Add content for the org-level code quality dashboard (#59713)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com>
1 parent 65abf22 commit 354d907

File tree

7 files changed

+61
-7
lines changed

7 files changed

+61
-7
lines changed

content/code-security/concepts/about-code-quality.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ With {% data variables.product.prodname_code_quality_short %}, you can:
2828
* Identify code quality risks and opportunities in **pull requests** and through **repository scans**.
2929
* Review clear explanations for findings and apply one-click **{% data variables.product.prodname_copilot_short %}-powered autofixes**.
3030
* Use **repository dashboards** to track reliability and maintainability scores, identify areas needing attention, and prioritize remediation.
31+
* Monitor **organization dashboards** to understand the code health of your repositories at a glance and determine which repositories to investigate further.
3132
* Set up **rulesets** for pull requests to enforce code quality standards and block changes that do not meet your criteria.
3233
* Easily assign remediation work to **{% data variables.copilot.copilot_coding_agent %}**, if you have a {% data variables.product.prodname_copilot_short %} license.
3334

@@ -49,7 +50,7 @@ With {% data variables.product.prodname_code_quality_short %}, you can:
4950

5051
{% data variables.product.prodname_code_quality_short %} also performs AI-powered analysis with results displayed separately on the "**{% data variables.code-quality.recent_suggestions %}**" repository dashboard. Unlike the rule-based {% data variables.product.prodname_codeql %} analysis that scans the entire codebase and pull requests, this AI-powered analysis only examines files recently pushed to the default branch and may identify issues in languages beyond those listed above. For more information, see [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
5152

52-
## Understanding where {% data variables.product.prodname_code_quality_short %} findings appear after enablement
53+
## Where will findings appear?
5354

5455
Once you enable {% data variables.product.prodname_code_quality_short %} for a repository, you'll see {% data variables.product.prodname_codeql %} scans for:
5556

@@ -76,5 +77,5 @@ Each {% data variables.product.prodname_codeql %} analysis will use {% data vari
7677

7778
## Next steps
7879

79-
* Enable {% data variables.product.prodname_code_quality_short %} for your repository, see [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality). Enterprise owners **may** need to first update their Advanced Security policies, see [AUTOTITLE](/code-security/code-quality/how-tos/allow-in-enterprise)
80+
* Enable {% data variables.product.prodname_code_quality_short %} for your repository, see [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality). Enterprise owners **may** need to first update their Advanced Security policies, see [AUTOTITLE](/code-security/code-quality/how-tos/allow-in-enterprise).
8081
* See how {% data variables.product.prodname_code_quality %} works on your default branch to surface code quality issues and help you understand your repository's code health at a glance. See [AUTOTITLE](/code-security/code-quality/get-started/quickstart).

content/code-security/how-tos/maintain-quality-code/enable-code-quality.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ redirect_from:
4141
4242
## Next steps
4343

44-
* Learn about the code quality backlog for your repository. See [AUTOTITLE](/code-security/code-quality/how-tos/interpret-results).
45-
* Find and fix code quality issues before they reach your default branch. See [AUTOTITLE](/code-security/code-quality/tutorials/fix-findings-in-prs).
44+
* **For your repository:** Understand your code quality backlog in detail. See [AUTOTITLE](/code-security/code-quality/how-tos/interpret-results).
45+
* **For your organization:** Understand the code health of your repositories at a glance. See [AUTOTITLE](/code-security/how-tos/view-and-interpret-data/analyze-organization-data/explore-code-quality).

content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ For more information about policies for {% data variables.product.prodname_AS %}
3737

3838
## Next steps
3939

40-
To see {% data variables.product.prodname_code_quality_short %} in action, turn the feature on for one or more repositories, [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
40+
To see {% data variables.product.prodname_code_quality_short %} in action, turn the feature on for one or more repositories. See [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Exploring GitHub Code Quality results in your organization
3+
shortTitle: Explore code quality
4+
intro: Understand your organization's code health at a glance with the organization-level dashboard for {% data variables.product.prodname_code_quality_short %}.
5+
product: '{% data reusables.gated-features.code-quality-availability %}'
6+
permissions: 'Organization members'
7+
contentType: how-tos
8+
versions:
9+
feature: code-quality
10+
topics:
11+
- Code Quality
12+
---
13+
14+
{% data reusables.code-quality.code-quality-preview-note %}
15+
16+
## Prerequisites
17+
18+
* If your organization belongs to an enterprise, an enterprise owner must enable {% data variables.product.prodname_code_quality_short %} for your organization. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).
19+
* Your organization must have repositories with {% data variables.product.prodname_code_quality_short %} enabled. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).
20+
21+
## Viewing code quality insights for your organization
22+
23+
1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your organization. For example, from [https://github.com/settings/organizations](https://github.com/settings/organizations?ref_product=github&ref_type=engagement&ref_style=text).
24+
{% data reusables.organizations.security-overview %}
25+
1. In the "Metrics" section of the sidebar, click {% octicon "code-square" aria-hidden="true" aria-label="code-square" %} **Code quality**.
26+
27+
> [!NOTE] The dashboard only displays data for repositories where the viewer can see code quality findings.
28+
29+
## Interpreting the score distribution chart
30+
31+
The score distribution chart provides a visual overview of the code health of your organization. Each bubble represents a collection of repositories with the same maintainability and reliability scores.
32+
* The **position** of each bubble demonstrates the overall health of those repositories. Higher bubbles represent higher maintainability scores, while bubbles further to the right represent higher reliability scores.
33+
* The **color and border pattern** of a bubble indicate the severity of the lower score for those repositories. For example, a bubble with a "Needs improvement" score in either category will always be red with a dashed border.
34+
* The **size** of each bubble represents the number of repositories with that particular score combination.
35+
36+
To view the maintainability score, reliability score, and number of repositories represented by a particular bubble, hover over the bubble.
37+
38+
## Exploring the repository table
39+
40+
Below the bubble chart, there is a table that lists all repositories in your organization. Here, you can view code quality findings, along with more detailed information about those findings.
41+
42+
You can sort the repository table in ascending or descending order for any column by clicking the column header.
43+
44+
## Investigating low-scoring repositories
45+
46+
1. To filter the dashboard data for the lowest-performing repositories, on the score distribution chart, click the bubble with the lowest combined scores.
47+
1. Scroll down to the repository table. By default, the table is sorted from most to least recent repository scan, helping you prioritize current quality issues.
48+
1. Optionally, to prioritize repositories with the highest number of {% data variables.product.prodname_codeql %} findings, click **Standard Findings** twice.
49+
1. To view the repository-level dashboard for a specific repository, click the repository's name.
50+
51+
## Next steps
52+
53+
To understand the code health information available on the repository-level dashboard, see [AUTOTITLE](/code-security/how-tos/maintain-quality-code/interpret-results).

content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ contentType: how-tos
1818
children:
1919
- /assessing-code-security-risk
2020
- /assessing-adoption-code-security
21+
- /explore-code-quality
2122
- /exporting-data-from-security-overview
2223
- /viewing-security-insights
2324
- /interpreting-security-findings

content/code-security/tutorials/improve-code-quality/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,3 @@ children:
1515
redirect_from:
1616
- /code-security/code-quality/tutorials
1717
---
18-
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{% ifversion fpt or ghec %}
2-
{% data variables.product.prodname_code_quality %} is available for organization-owned repositories on {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}
2+
{% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}
33
{% endif %}

0 commit comments

Comments
 (0)