Skip to content

Commit 2a37557

Browse files
hubwriterCopilot
hubwriter
and
Copilot
authored
Mention excluded files (#58584)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 21a796c commit 2a37557

File tree

3 files changed

+109
-16
lines changed

3 files changed

+109
-16
lines changed

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

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,28 @@ category:
2626

2727
This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. For instructions on how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review).
2828

29-
### {% data variables.copilot.copilot_code-review-tools-preview_cap %}
29+
## Availability
30+
31+
{% data variables.copilot.copilot_code-review_short %} is supported in:
32+
33+
* {% data variables.product.prodname_dotcom_the_website %}
34+
* {% data variables.product.prodname_mobile %}
35+
* {% data variables.product.prodname_vscode_shortname %}
36+
* {% data variables.product.prodname_vs %}
37+
* Xcode
38+
* JetBrains IDEs
39+
40+
{% data variables.copilot.copilot_code-review_short %} is a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text).
41+
42+
If you receive {% data variables.product.prodname_copilot_short %} from an organization then, to be able to request a pull request review from {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}, the **{% data variables.copilot.copilot_code-review_short %}** option must be enabled in the {% data variables.product.prodname_copilot_short %} policy settings for the organization. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization).
43+
44+
## Excluded files
45+
46+
Dependency management files (such as package.json and Gemfile.lock) and certain other types of files (such as log files and SVGs) are excluded from {% data variables.copilot.copilot_code-review_short %}. If you include any of these files in a pull request, {% data variables.copilot.copilot_code-review_short %} will not consider the file when carrying out the review. Similarly, using {% data variables.copilot.copilot_code-review_short %} on one of these files in your IDE, will not generate review comments.
47+
48+
For more information, see [AUTOTITLE](/copilot/reference/review-excluded-files).
49+
50+
## {% data variables.copilot.copilot_code-review-tools-preview_cap %}
3051

3152
> [!NOTE]
3253
>
@@ -50,21 +71,6 @@ In the event that {% data variables.product.prodname_actions %} is unavailable o
5071
>
5172
> Usage charges will apply when the feature becomes generally available.
5273
53-
## Availability
54-
55-
{% data variables.copilot.copilot_code-review_short %} is supported in:
56-
57-
* {% data variables.product.prodname_dotcom_the_website %}
58-
* {% data variables.product.prodname_mobile %}
59-
* {% data variables.product.prodname_vscode_shortname %}
60-
* {% data variables.product.prodname_vs %}
61-
* Xcode
62-
* JetBrains IDEs
63-
64-
{% data variables.copilot.copilot_code-review_short %} is a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text).
65-
66-
If you receive {% data variables.product.prodname_copilot_short %} from an organization then, to be able to request a pull request review from {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}, the **{% data variables.copilot.copilot_code-review_short %}** option must be enabled in the {% data variables.product.prodname_copilot_short %} policy settings for the organization. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization).
67-
6874
## Code review monthly quota
6975

7076
Each time {% data variables.product.prodname_copilot_short %} reviews a pull request, or reviews code in your IDE, your monthly quota of Copilot premium requests is reduced by one.

‎content/copilot/reference/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ children:
1717
- /metrics-data
1818
- /copilot-billing
1919
- /agentic-audit-log-events
20+
- /review-excluded-files
2021
- /copilot-usage-metrics
2122
contentType: reference
2223
---

‎content/copilot/reference/review-excluded-files.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Files excluded from {% data variables.copilot.copilot_code-review %}
3+
shortTitle: Review excluded files
4+
intro: 'Understand the types of files that are excluded from a review by {% data variables.product.prodname_copilot_short %}.'
5+
versions:
6+
feature: copilot
7+
topics:
8+
- Copilot
9+
category:
10+
- Author and optimize with Copilot
11+
contentType: reference
12+
---
13+
14+
Certain types of files are excluded from {% data variables.copilot.copilot_code-review_short %}. These include dependency management files, log files, SVG files, and files in locations typically reserved for vendor files or automatically generated files.
15+
16+
If you include any of these files in a pull request, {% data variables.copilot.copilot_code-review_short %} will not consider the file when carrying out the review. Similarly, using {% data variables.copilot.copilot_code-review_short %} on one of these files in your IDE, will not generate review comments.
17+
18+
This is an example of some of the files that are excluded from {% data variables.copilot.copilot_code-review_short %}:
19+
20+
* `.gitignore`
21+
* `package-lock.json`
22+
* `yarn.lock`
23+
* `jest.config.js`
24+
* `next.config.js`
25+
* `tailwind.config.js`
26+
* `tsconfig.json`
27+
* `requirements.txt`
28+
* `Pipfile.lock`
29+
* `Gemfile.lock`
30+
* `composer.lock`
31+
* `Cargo.lock`
32+
* `go.sum`
33+
* `paket.lock`
34+
* `pubspec.lock`
35+
* `stack.yaml`
36+
* `elm.json`
37+
* `Project.toml`
38+
* `Manifest.toml`
39+
* `renv.lock`
40+
* `build.sbt`
41+
* `Package.resolved`
42+
* `deps.edn`
43+
* `build.gradle`
44+
* `mix.lock`
45+
* `build.gradle.kts`
46+
* `cpanfile`
47+
* `Podfile.lock`
48+
* `conanfile.txt`
49+
* `info.rkt`
50+
* `rockspec`
51+
* `opam`
52+
* `rebar.config`
53+
* `nimble`
54+
* `shard.yml`
55+
* `dub.json`
56+
* `dub.sdl`
57+
* `GPR`
58+
* `Mason.toml`
59+
* `fpm.toml`
60+
* `pack.pl`
61+
* `baseline.st`
62+
* `PacletInfo.m`
63+
* `info.ss`
64+
* `Jpkg`
65+
* `box.json`
66+
* `GNAVI.xml`
67+
68+
Files matching these patterns are also excluded:
69+
70+
* `**/*.svg`
71+
* `**/*.log`
72+
* `**/*.lock`
73+
* `**/go.sum`
74+
* `**/*.ipynb.raw.html`
75+
* `**/dist/**/*`
76+
* `**/node_modules/**/*`
77+
* `**/*.min.js`
78+
* `**/*.d.ts`
79+
* `**/coverage/**/*`
80+
* `**/*.bundle.js`
81+
* `**/*.map`
82+
* `**/out/**/*`
83+
* `**/vendor/**/*`
84+
* `**/bin/**/*`
85+
* `**/generated/**/*`
86+
* `**/generated-sources/**/*`

0 commit comments

Comments
 (0)