Skip to content

Commit bee1207

Browse files
Add content for the standalone Code Quality policy (#59805)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
1 parent 272b9b4 commit bee1207

File tree

3 files changed

+12
-21
lines changed

3 files changed

+12
-21
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ With {% data variables.product.prodname_code_quality_short %}, you can:
4040

4141
> [!NOTE]
4242
> * You **don't** need a {% data variables.product.prodname_copilot_short %} or a {% data variables.product.prodname_code_security %} license to use {% data variables.product.prodname_code_quality_short %} or apply {% data variables.product.prodname_copilot_short %}-powered autofixes.
43-
> * During the {% data variables.release-phases.public_preview %}, an enterprise policy that blocks the use of {% data variables.product.prodname_code_security %} by repository owners will also block use of {% data variables.product.prodname_code_quality_short %}. See [AUTOTITLE](/code-security/code-quality/how-tos/allow-in-enterprise).
4443
4544
## Supported languages
4645

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

7877
## Next steps
7978

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).
81-
* 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).
79+
* **For your repository:** Turn on {% data variables.product.prodname_code_quality_short %} to start generating results. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).
80+
* **For your enterprise:** Ensure repositories in your enterprise can enable {% data variables.product.prodname_code_quality_short %}. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).

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
@@ -28,7 +28,7 @@ redirect_from:
2828
1. Click **Enable code quality**.
2929

3030
> [!NOTE]
31-
> If **Enable code quality** is missing from this view, your enterprise owner has disabled the use of {% data variables.product.prodname_code_security %} and {% data variables.product.prodname_code_quality_short %} for your organization. See [AUTOTITLE](/code-security/code-quality/how-tos/allow-in-enterprise).
31+
> If **Enable code quality** is missing from this view, your enterprise owner has disabled the use of {% data variables.product.prodname_code_quality_short %} for your organization. See [AUTOTITLE](/code-security/code-quality/how-tos/allow-in-enterprise).
3232
1. Review the information on the Code quality page:
3333

3434
* **Languages:** If you want to disable {% data variables.product.prodname_codeql %} analysis for any of the languages, clear the associated check box.
@@ -41,5 +41,5 @@ redirect_from:
4141
4242
## Next steps
4343

44-
* **For your repository:** Understand your code quality backlog in detail. See [AUTOTITLE](/code-security/code-quality/how-tos/interpret-results).
44+
* **For your repository:** Explore your code quality findings and merge your first fix. See [AUTOTITLE](/code-security/tutorials/improve-code-quality/quickstart).
4545
* **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: 8 additions & 16 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: Define policies for {% data variables.product.prodname_AS %} that allow repository owners to enable {% data variables.product.prodname_code_quality %}.
4+
intro: Control {% data variables.product.prodname_code_quality_short %} enablement for your repositories by defining policies.
55
versions:
66
feature: code-quality
77
product: '{% data reusables.gated-features.code-quality-availability %}'
@@ -16,24 +16,16 @@ redirect_from:
1616
- /code-security/code-quality/how-tos/allow-in-enterprise
1717
---
1818

19-
{% data reusables.code-quality.code-quality-preview-note %}
20-
21-
## Policy control during the {% data variables.release-phases.public_preview %}
22-
23-
During the {% data variables.release-phases.public_preview %}, the {% data variables.product.prodname_AS %} policies have been extended to control access to {% data variables.product.prodname_code_quality %}. If you create a new enterprise, {% data variables.product.prodname_GH_secret_protection %}, {% data variables.product.prodname_GH_code_security %}, and {% data variables.product.prodname_code_quality %} are initially available for repository owners to use across all organizations.
24-
25-
For an existing enterprise, {% data variables.product.prodname_code_quality %} is available to repository owners if the {% data variables.product.prodname_AS %} policy already allows the use of {% data variables.product.prodname_GH_code_security %}.
26-
27-
## Allowing repository owners to enable {% data variables.product.prodname_code_quality_short %}
19+
> [!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.
2822
2923
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).
3024
{% data reusables.enterprise-accounts.policies-tab %}
31-
{% data reusables.enterprise-accounts.code-security-and-analysis-policies %}
32-
1. Under "General", select **Allow for all organizations**, or **Allow for selected organizations**.
33-
1. If you choose "Allow for selected organizations", for each organization of interest ensure that the policy is **All plans** or **{% data variables.product.prodname_code_security %} and {% data variables.product.prodname_code_quality_short %} only**.
34-
1. In the "{% data variables.product.prodname_code_security %} and {% data variables.product.prodname_code_quality_short %}" section, set the "Repository administrators can enable or disable {% data variables.product.prodname_code_security %} and {% data variables.product.prodname_code_quality_short %}" option to **All repositories: Allowed**.
35-
36-
For more information about policies for {% data variables.product.prodname_AS %}, see [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise).
25+
1. In the sidebar, click {% octicon "code-square" aria-hidden="true" aria-label="code-square" %} **{% data variables.product.prodname_code_quality_short %}**.
26+
1. Select the "Organization access" dropdown menu, then click **Allow for all organizations** or **Allow for selected organizations**.
27+
1. If you choose "Allow for selected organizations", select the dropdown menu for each organization where you want to enable {% data variables.product.prodname_code_quality_short %}, then click **Available**.
28+
1. To allow repository administrators to enable {% data variables.product.prodname_code_quality_short %} on their repositories, select the "Repository admin policy" dropdown menu, then click **Allowed**.
3729

3830
## Next steps
3931

0 commit comments

Comments
 (0)