Add a driver journey landing page for Code Quality (#62542) · github/docs@1f117f6 · GitHub
Skip to content

Commit 1f117f6

Browse files
mchammer01jc-clark
mchammer01
and
jc-clark
authored
Add a driver journey landing page for Code Quality (#62542)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Copilot-Session: d7978248-7b32-4acd-85e2-c89aa908656c Copilot-Session: ea8e7006-076c-4e98-9e5a-0ea41e475767 Copilot-Session: 7bed5438-5c04-44d1-8ee9-b25e63bd7ad3
1 parent 5dacd7c commit 1f117f6

13 files changed

Lines changed: 75 additions & 72 deletions

File tree

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

Lines changed: 0 additions & 6 deletions

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,3 @@ For the available access options, and how filtering and enforcement work, see [A
5656
Your changes are saved automatically and begin to propagate immediately. In large organizations, it can take several minutes for the changes to apply across all repositories.
5757

5858
If you're rolling out the feature across many teams, we recommend you pilot on a small group and tune your quality thresholds before you enable everywhere. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/roll-out-at-scale).
59-
60-
## Next steps
61-
62-
* **Add code coverage:** Upload reported code coverage from your test suite to see coverage results directly on pull requests. {% data reusables.code-quality.workflow-generation %}
63-
* **For your organization:** Understand the code health of your repositories at a glance. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/explore-code-quality).

‎content/code-security/how-tos/maintain-quality-code/explore-code-quality.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Exploring GitHub Code Quality results in your organization
33
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 %}.
4+
intro: Use the organization-level {% data variables.product.prodname_code_quality_short %} dashboard to spot repositories that need attention and track your organization's code health at a glance.
55
product: '{% data reusables.gated-features.code-quality-availability %}'
66
permissions: Organization members
77
audience:
@@ -52,7 +52,3 @@ You can sort the repository table in ascending or descending order for any colum
5252
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.
5353
1. Optionally, to prioritize repositories with the highest number of {% data variables.product.prodname_codeql %} findings, click **Standard Findings** twice.
5454
1. To view the repository-level dashboard for a specific repository, click the repository's name.
55-
56-
## Next steps
57-
58-
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/maintain-quality-code/interpret-results.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Interpreting the code quality results for your repository
33
shortTitle: Interpret results
44
allowTitleToDifferFromFilename: true
5-
intro: Understand the maintainability and reliability of your codebase so you can prioritize where your teams focus remediation effort.
5+
intro: Use {% data variables.product.prodname_code_quality_short %} results to assess the maintainability and reliability of your codebase, so your teams can focus remediation where it matters most.
66
versions:
77
feature: code-quality
88
product: '{% data reusables.gated-features.code-quality-availability %}'
@@ -53,8 +53,3 @@ Code quality results should always be interpreted in the context of your reposit
5353
* Large repositories with a lot of code in a fully supported language often have many results even if the majority of the code has good maintainability and reliability standards.
5454

5555
To learn more about the metrics and how the scores are calculated, see [AUTOTITLE](/code-security/reference/code-quality/metrics-and-ratings).
56-
57-
## Next steps
58-
59-
* Remediate quality findings in your default branch and improve the maintainability and reliability score for your repository. See [AUTOTITLE](/code-security/tutorials/improve-code-quality/raise-your-quality-rating).
60-
* Stop your repository from accumulating more code quality problems by setting a quality threshold for pull requests using rulesets. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/set-pr-thresholds).

‎content/code-security/how-tos/maintain-quality-code/roll-out-at-scale.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,3 @@ If you need automation around your rollout, you can fetch {% data variables.prod
7575
Enabling {% data variables.product.prodname_code_quality_short %} does not automatically turn on code coverage. Coverage is opt-in per repository, and it starts reporting only after a workflow that uploads coverage data is added to the repository. This means teams can adopt {% data variables.product.prodname_code_quality_short %} first and add coverage later.
7676

7777
To set up coverage for a repository, see [AUTOTITLE](/code-security/how-tos/maintain-quality-code/set-up-code-coverage).
78-
79-
## Next steps
80-
81-
Now that you've rolled out {% data variables.product.prodname_code_quality_short %} across your organization, you can assess the health of your repositories at a glance and decide where to focus. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/explore-code-quality).

‎content/code-security/how-tos/maintain-quality-code/set-pr-thresholds.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Setting code quality thresholds for pull requests
33
shortTitle: Set quality thresholds
4-
intro: Enforce your code quality standards automatically by blocking pull requests that fall below the thresholds you set, at the repository or organization level.
4+
intro: Keep low-quality changes out of your codebase by using {% data variables.product.prodname_code_quality_short %} thresholds to block pull requests that don't meet your standards.
55
allowTitleToDifferFromFilename: true
66
versions:
77
feature: code-quality
@@ -51,7 +51,7 @@ The following steps create or update a ruleset at the repository level. To enfor
5151
1. If you don't already have a ruleset to protect your default branch, expand **New ruleset** and click **New branch ruleset**. Alternatively, open your existing ruleset for the default branch and move to step 5.
5252
1. If you are creating a new ruleset:
5353
* Define a name for the ruleset.
54-
* Set the "Enforcement status" to "Active."
54+
* Set the "Enforcement status" to "Evaluate" while you calibrate the threshold during a pilot. If you want to enforce the threshold immediately, select "Active."
5555
* Under "Target branches" add a target of "Include default branch."
5656
1. Under "Branch rules", enable "Require code quality results".
5757
1. Set "Severity" to define the lowest severity of code quality results that must be resolved before a pull request can be merged into the default branch. For example:
@@ -61,10 +61,8 @@ The following steps create or update a ruleset at the repository level. To enfor
6161
* Set "All" to block pull requests with **any** unresolved code quality results being merged.
6262
1. When you have finished defining or editing the ruleset, click **Create** or **Save changes**.
6363

64+
If you selected "Evaluate", review the ruleset insights to see which pull requests would have been blocked. When the results match the quality bar you want, change the enforcement status to "Active."
65+
6466
## Setting a code coverage threshold
6567

6668
You can also block pull requests that fall below a code coverage threshold. This uses a separate **Restrict code coverage** rule, not the **Require code quality results** rule used above, and your repository must upload code coverage data first. For the full procedure, see [AUTOTITLE](/code-security/how-tos/maintain-quality-code/restrict-code-coverage).
67-
68-
## Next steps
69-
70-
Learn how {% data variables.product.prodname_code_quality %} works on pull requests to prevent code quality issues from reaching your default branch. See [AUTOTITLE](/code-security/tutorials/improve-code-quality/catch-issues-before-merge).

‎content/code-security/how-tos/maintain-quality-code/set-up-code-coverage.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Setting up code coverage for your repository
33
shortTitle: Set up code coverage
4-
intro: 'Give your teams visibility into code coverage directly on pull requests, without paying for or maintaining a separate third-party coverage service.'
4+
intro: 'Use built-in code coverage from {% data variables.product.prodname_code_quality_short %} to find untested code on pull requests, without paying for or maintaining a separate third-party service.'
55
versions:
66
feature: code-quality
77
product: '{% data reusables.gated-features.code-quality-availability %}'
@@ -163,8 +163,3 @@ jobs:
163163
1. After the workflow completes, look for a comment from `{% data variables.code-quality.pr_commenter %}` on the pull request. The comment includes:
164164
* The aggregate coverage percentage for the pull request branch compared to the default branch.
165165
* A per-file breakdown showing which files gained or lost coverage.
166-
167-
## Next steps
168-
169-
* **Interpret results:** Understand coverage metrics and per-file breakdowns on your pull requests. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/interpret-results).
170-
* **Enforce coverage thresholds:** Block pull requests that don't meet a minimum coverage percentage or that cause coverage to drop. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/restrict-code-coverage).

‎content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,3 @@ Be aware of two limits so there are no surprises:
7474

7575
* **You can't pre-estimate spend** before you enable {% data variables.product.prodname_code_quality_short %}. Usage depends on your committers, scan frequency, and findings, so plan to watch actuals after you turn it on rather than forecast them precisely.
7676
* **You can't turn off the in-pull-request AI features.** {% data variables.product.prodname_code_quality_short %} generates a fix for every detected finding, so {% data variables.product.prodname_ai_credits_short %} usage is inherent to running it. To stop that usage entirely, disable {% data variables.product.prodname_code_quality_short %} on the repository.
77-
78-
## Next steps
79-
80-
* **Roll out across your organization.** See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/roll-out-at-scale).
81-
* **Assess health across your organization.** See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/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: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Allowing use of {% data variables.product.prodname_code_quality %} in your enterprise
33
shortTitle: Allow {% data variables.product.prodname_code_quality_short %}
4-
intro: Control {% data variables.product.prodname_code_quality_short %} enablement for your repositories by defining policies.
4+
intro: Set enterprise policies for {% data variables.product.prodname_code_quality_short %} to give organizations access while keeping repository enablement under your control.
55
versions:
66
feature: code-quality
77
product: '{% data reusables.gated-features.code-quality-availability %}'
@@ -17,8 +17,7 @@ category:
1717
---
1818

1919
> [!NOTE]
20-
> * {% data variables.product.prodname_code_quality %} is currently in {% data variables.release-phases.public_preview %} and subject to change. During {% data variables.release-phases.public_preview %}, {% data variables.product.prodname_code_quality_short %} will not be billed, although {% data variables.product.prodname_code_quality_short %} scans will consume {% data variables.product.prodname_actions %} minutes.
21-
> * Previously, {% data variables.product.prodname_AS %} policies also controlled access to {% data variables.product.prodname_code_quality_short %}. Those existing policy settings are automatically applied to the standalone {% data variables.product.prodname_code_quality_short %} policies.
20+
> Previously, {% data variables.product.prodname_AS %} policies also controlled access to {% data variables.product.prodname_code_quality_short %}. Those existing policy settings are automatically applied to the standalone {% data variables.product.prodname_code_quality_short %} policies.
2221
2322
1. Navigate to your enterprise. For example, from [https://github.com/settings/enterprises](https://github.com/settings/enterprises?ref_product=ghec&ref_type=engagement&ref_style=text).
2423
{% data reusables.enterprise-accounts.policies-tab %}

‎content/code-security/index.md‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)