Mention excluded files (#58584)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -26,7 +26,28 @@ category:
|
||||
|
||||
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).
|
||||
|
||||
### {% data variables.copilot.copilot_code-review-tools-preview_cap %}
|
||||
## Availability
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} is supported in:
|
||||
|
||||
* {% data variables.product.prodname_dotcom_the_website %}
|
||||
* {% data variables.product.prodname_mobile %}
|
||||
* {% data variables.product.prodname_vscode_shortname %}
|
||||
* {% data variables.product.prodname_vs %}
|
||||
* Xcode
|
||||
* JetBrains IDEs
|
||||
|
||||
{% 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).
|
||||
|
||||
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).
|
||||
|
||||
## Excluded files
|
||||
|
||||
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.
|
||||
|
||||
For more information, see [AUTOTITLE](/copilot/reference/review-excluded-files).
|
||||
|
||||
## {% data variables.copilot.copilot_code-review-tools-preview_cap %}
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
@@ -50,21 +71,6 @@ In the event that {% data variables.product.prodname_actions %} is unavailable o
|
||||
>
|
||||
> Usage charges will apply when the feature becomes generally available.
|
||||
|
||||
## Availability
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} is supported in:
|
||||
|
||||
* {% data variables.product.prodname_dotcom_the_website %}
|
||||
* {% data variables.product.prodname_mobile %}
|
||||
* {% data variables.product.prodname_vscode_shortname %}
|
||||
* {% data variables.product.prodname_vs %}
|
||||
* Xcode
|
||||
* JetBrains IDEs
|
||||
|
||||
{% 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).
|
||||
|
||||
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).
|
||||
|
||||
## Code review monthly quota
|
||||
|
||||
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.
|
||||
|
||||
@@ -17,6 +17,7 @@ children:
|
||||
- /metrics-data
|
||||
- /copilot-billing
|
||||
- /agentic-audit-log-events
|
||||
- /review-excluded-files
|
||||
- /copilot-usage-metrics
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
86
content/copilot/reference/review-excluded-files.md
Normal file
86
content/copilot/reference/review-excluded-files.md
Normal file
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: Files excluded from {% data variables.copilot.copilot_code-review %}
|
||||
shortTitle: Review excluded files
|
||||
intro: 'Understand the types of files that are excluded from a review by {% data variables.product.prodname_copilot_short %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
category:
|
||||
- Author and optimize with Copilot
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
This is an example of some of the files that are excluded from {% data variables.copilot.copilot_code-review_short %}:
|
||||
|
||||
* `.gitignore`
|
||||
* `package-lock.json`
|
||||
* `yarn.lock`
|
||||
* `jest.config.js`
|
||||
* `next.config.js`
|
||||
* `tailwind.config.js`
|
||||
* `tsconfig.json`
|
||||
* `requirements.txt`
|
||||
* `Pipfile.lock`
|
||||
* `Gemfile.lock`
|
||||
* `composer.lock`
|
||||
* `Cargo.lock`
|
||||
* `go.sum`
|
||||
* `paket.lock`
|
||||
* `pubspec.lock`
|
||||
* `stack.yaml`
|
||||
* `elm.json`
|
||||
* `Project.toml`
|
||||
* `Manifest.toml`
|
||||
* `renv.lock`
|
||||
* `build.sbt`
|
||||
* `Package.resolved`
|
||||
* `deps.edn`
|
||||
* `build.gradle`
|
||||
* `mix.lock`
|
||||
* `build.gradle.kts`
|
||||
* `cpanfile`
|
||||
* `Podfile.lock`
|
||||
* `conanfile.txt`
|
||||
* `info.rkt`
|
||||
* `rockspec`
|
||||
* `opam`
|
||||
* `rebar.config`
|
||||
* `nimble`
|
||||
* `shard.yml`
|
||||
* `dub.json`
|
||||
* `dub.sdl`
|
||||
* `GPR`
|
||||
* `Mason.toml`
|
||||
* `fpm.toml`
|
||||
* `pack.pl`
|
||||
* `baseline.st`
|
||||
* `PacletInfo.m`
|
||||
* `info.ss`
|
||||
* `Jpkg`
|
||||
* `box.json`
|
||||
* `GNAVI.xml`
|
||||
|
||||
Files matching these patterns are also excluded:
|
||||
|
||||
* `**/*.svg`
|
||||
* `**/*.log`
|
||||
* `**/*.lock`
|
||||
* `**/go.sum`
|
||||
* `**/*.ipynb.raw.html`
|
||||
* `**/dist/**/*`
|
||||
* `**/node_modules/**/*`
|
||||
* `**/*.min.js`
|
||||
* `**/*.d.ts`
|
||||
* `**/coverage/**/*`
|
||||
* `**/*.bundle.js`
|
||||
* `**/*.map`
|
||||
* `**/out/**/*`
|
||||
* `**/vendor/**/*`
|
||||
* `**/bin/**/*`
|
||||
* `**/generated/**/*`
|
||||
* `**/generated-sources/**/*`
|
||||
Reference in New Issue
Block a user