Skip to content

Commit 6fb6245

Browse files
sabrowning1ria-gopuhubwriterSiaraMist
authored
Add content for static analysis tools in Copilot code review (#58514)
Co-authored-by: Ria Gopu <[email protected]> Co-authored-by: hubwriter <[email protected]> Co-authored-by: Siara <[email protected]>
1 parent 62aa85d commit 6fb6245

File tree

4 files changed

+50
-2
lines changed

4 files changed

+50
-2
lines changed

content/copilot/concepts/agents/code-review.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This article provides an overview of {% data variables.copilot.copilot_code-revi
3737
{% data variables.copilot.copilot_code-review_short %} has several new tools that are in {% data variables.release-phases.public_preview %} and subject to change.
3838

3939
* **Full project context gathering** to provide more specific, accurate, and contextually aware code reviews.
40-
* **Support for deterministic detections with {% data variables.product.prodname_codeql %}**, to deliver more high-signal, consistent findings for quality.
40+
* **Support for static analysis tools like {% data variables.product.prodname_codeql %}, ESLint, and PMD** to deliver more high-signal, consistent findings for security and quality.
4141
* **The ability to pass suggestions to {% data variables.copilot.copilot_coding_agent %}**, for automated creation of a new pull request against your branch with the suggested fixes applied.
4242

4343
You are not required to have {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_actions %} enabled in your organization or enterprise to use the {% data variables.copilot.copilot_code-review-tools_short %}.
@@ -120,6 +120,15 @@ The triggers for automatic code review depend on the configuration settings:
120120

121121
For details of how to configure {% data variables.product.prodname_copilot_short %} to automatically review new pull requests, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot).
122122

123+
## About static analysis tools
124+
125+
You can enable static analysis tools in {% data variables.copilot.copilot_code-review_short %} to enhance its ability to identify and fix issues. Available tools include:
126+
* **{% data variables.product.prodname_codeql %}**: A code analysis engine that identifies security vulnerabilities. For more information, see [About {% data variables.product.prodname_codeql %}](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql).
127+
* **ESLint**: A linter designed specifically for JavaScript. For more information, see [Core Concepts](https://eslint.org/docs/latest/use/core-concepts/) in the the ESLint documentation.
128+
* **PMD**: A static code analyzer that focuses on Java and Apex, but also supports many other languages. For more information, see the [PMD documentation](https://docs.pmd-code.org/latest/).
129+
130+
If you have access to {% data variables.copilot.copilot_code-review-tools_short %}, {% data variables.product.prodname_codeql %} is enabled by default, while ESLint and PMD are disabled. Additionally, if you have access to rulesets, you can change your selected tools. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/manage-tools).
131+
123132
## Getting detailed code quality feedback for your whole repository
124133

125134
{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want to surface actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality).

content/copilot/how-tos/use-copilot-agents/request-a-code-review/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
title: Code review
33
shortTitle: Request a code review
4-
intro: 'Learn how to request a code review from {% data variables.product.prodname_copilot %}.'
4+
intro: 'Learn how you can request and configure reviews from {% data variables.product.prodname_copilot_short %}.'
55
versions:
66
feature: copilot
77
topics:
88
- Copilot
99
children:
1010
- /use-code-review
1111
- /configure-automatic-review
12+
- /manage-tools
1213
redirect_from:
1314
- /copilot/using-github-copilot/code-review
1415
- /copilot/how-tos/agents/copilot-code-review
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Managing static analysis tools in Copilot code review
3+
shortTitle: Manage tools
4+
intro: 'Improve your code security and linting configuration with static analysis tools in {% data variables.copilot.copilot_code-review_short %}.'
5+
versions:
6+
feature: copilot
7+
permissions: Repository administrators and organization owners
8+
product: 'Rulesets are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}.'
9+
topics:
10+
- Copilot
11+
contentType: how-tos
12+
category:
13+
- Author and optimize with Copilot
14+
---
15+
16+
## Prerequisites
17+
18+
If you get access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise, your organization or enterprise owner needs to enable preview features for {% data variables.copilot.copilot_code-review_short %}. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).
19+
20+
## Managing static analysis tools for your repository
21+
22+
{% data reusables.repositories.navigate-to-repo %}
23+
{% data reusables.repositories.sidebar-settings %}
24+
{% data reusables.repositories.repo-rulesets-settings %}
25+
{% data reusables.copilot.code-review.manage-static-analysis-tools %}
26+
27+
## Configuring static analysis tools for your organization
28+
29+
{% data reusables.organizations.navigate-to-org %}
30+
{% data reusables.organizations.org_settings %}
31+
{% data reusables.organizations.access-ruleset-settings %}
32+
{% data reusables.copilot.code-review.manage-static-analysis-tools %}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
1. Edit or create a ruleset for {% data variables.copilot.copilot_code-review_short %}:
2+
* If you have **configured a ruleset for automatic reviews** from {% data variables.copilot.copilot_code-review_short %}, click the name of that ruleset.
3+
* If you **do not have an existing ruleset** for {% data variables.copilot.copilot_code-review_short %}, select the **New ruleset** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle" %} dropdown menu, then click **New branch ruleset** and give your ruleset a name.
4+
1. In the "Rules" section, select **Manage static analysis tools in {% data variables.copilot.copilot_code-review_short %}**.
5+
1. To update the tools that {% data variables.copilot.copilot_code-review_short %} will use, select the **Select tools** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then select or deselect the available tools.
6+
1. To apply your selections, at the bottom of the page, click **Create** or **Save changes**.

0 commit comments

Comments
 (0)