Skip to content

Commit 6450eea

Browse files
authored
[EDI - Builders] - Copilot "How-Tos" ("Exclude content from Copilot") #5527 (#56586)
1 parent c315f5b commit 6450eea

File tree

4 files changed

+68
-49
lines changed

4 files changed

+68
-49
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Content exclusion for GitHub Copilot
3+
shortTitle: Content exclusion
4+
intro: 'You can prevent {% data variables.product.prodname_copilot_short %} from accessing certain files.'
5+
product: '{% data reusables.gated-features.copilot-business-and-enterprise %}'
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
---
11+
12+
## About content exclusion for {% data variables.product.prodname_copilot_short %}
13+
14+
You can use content exclusion to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When you exclude content from {% data variables.product.prodname_copilot_short %}:
15+
16+
* Code completion will not be available in the affected files.
17+
* The content in affected files will not inform code completion suggestions in other files.
18+
* The content in affected files will not inform {% data variables.copilot.copilot_chat %}'s responses.
19+
* Affected files will not be reviewed in a {% data variables.product.prodname_copilot_short %} code review.
20+
21+
### Who can configure content exclusion
22+
23+
Repository administrators, organization owners, and enterprise owners can configure content exclusion.
24+
25+
{% data reusables.copilot.content-exclusions-scope %}
26+
27+
### Availability of content exclusion
28+
29+
The {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans provide the following level of support for content exclusion.
30+
31+
| Tool | Code completion support | {% data variables.copilot.copilot_chat_short %} support |
32+
|-------------------------------------------------|:---------------------------------------------:|:----------------------------------------------------------------:|
33+
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
34+
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
35+
| JetBrains IDEs | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
36+
| Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable |
37+
| Xcode | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
38+
| Eclipse | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
39+
| Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable |
40+
| The {% data variables.product.github %} website | Not applicable | {% octicon "check" aria-label="Supported" %} |
41+
| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "check" aria-label="Supported" %} |
42+
43+
Content exclusions also apply to {% data variables.copilot.copilot_code-review_short %} on the {% data variables.product.github %} website.
44+
45+
> [!NOTE]
46+
> * Content exclusion is in {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website and in {% data variables.product.prodname_mobile %} and is subject to change.
47+
> * Content exclusion is currently not supported in Edit and Agent modes of {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}.
48+
49+
### Limitations of content exclusion
50+
51+
{% data reusables.copilot.content-exclusion-limitations %}
52+
53+
Currently, content exclusions do not apply to symbolic links (symlinks).
54+
55+
### Data sent to {% data variables.product.prodname_dotcom %}
56+
57+
After you configure content exclusion, the client (for example, the {% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_vscode_shortname %}) sends the current repository URL to the {% data variables.product.prodname_dotcom %} server so that the server can return the correct policy to the client. These URLs are not logged anywhere.
58+
59+
## Further reading
60+
61+
* [AUTOTITLE](/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot)
62+
* [AUTOTITLE](/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot)

content/copilot/concepts/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ children:
1010
- /copilot-billing
1111
- /prompt-engineering-for-copilot-chat
1212
- /about-customizing-github-copilot-chat-responses
13-
- /about-copilot-coding-agent
13+
- /content-exclusion-for-github-copilot
1414
- /indexing-repositories-for-copilot-chat
15+
- /about-copilot-coding-agent
1516
- /about-organizing-and-sharing-context-with-copilot-spaces
1617
- /build-copilot-extensions
1718
---

content/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Excluding content from GitHub Copilot
33
shortTitle: Exclude content from Copilot
4-
intro: 'You can prevent {% data variables.product.prodname_copilot_short %} from accessing certain content.'
4+
intro: 'Learn how to prevent {% data variables.product.prodname_copilot_short %} from accessing certain content.'
55
permissions: 'Repository administrators, organization owners, and enterprise owners can manage content exclusion settings. People with the "Maintain" role for a repository can view, but not edit, content exclusion settings for that repository.'
66
product: '{% data reusables.gated-features.copilot-business-and-enterprise %}'
77
layout: inline
@@ -23,53 +23,6 @@ topics:
2323
- Copilot
2424
---
2525

26-
## About content exclusion for {% data variables.product.prodname_copilot_short %}
27-
28-
You can use content exclusion to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When you exclude content from {% data variables.product.prodname_copilot_short %}:
29-
30-
* Code completion will not be available in the affected files.
31-
* The content in affected files will not inform code completion suggestions in other files.
32-
* The content in affected files will not inform {% data variables.copilot.copilot_chat %}'s responses.
33-
* Affected files will not be reviewed in a {% data variables.product.prodname_copilot_short %} code review.
34-
35-
### Who can configure content exclusion
36-
37-
Repository administrators, organization owners, and enterprise owners can configure content exclusion.
38-
39-
{% data reusables.copilot.content-exclusions-scope %}
40-
41-
### Availability of content exclusion
42-
43-
The {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans provide the following level of support for content exclusion.
44-
45-
| Tool | Code completion support | {% data variables.copilot.copilot_chat_short %} support |
46-
|-------------------------------------------------|:---------------------------------------------:|:----------------------------------------------------------------:|
47-
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
48-
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
49-
| JetBrains IDEs | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
50-
| Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable |
51-
| Xcode | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
52-
| Eclipse | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
53-
| Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable |
54-
| The {% data variables.product.github %} website | Not applicable | {% octicon "check" aria-label="Supported" %} |
55-
| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "check" aria-label="Supported" %} |
56-
57-
Content exclusions also apply to {% data variables.copilot.copilot_code-review_short %} on the {% data variables.product.github %} website.
58-
59-
> [!NOTE]
60-
> * Content exclusion is in {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website and in {% data variables.product.prodname_mobile %} and is subject to change.
61-
> * Content exclusion is currently not supported in Edit and Agent modes of {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}.
62-
63-
### Limitations of content exclusion
64-
65-
{% data reusables.copilot.content-exclusion-limitations %}
66-
67-
Currently, content exclusions do not apply to symbolic links (symlinks).
68-
69-
### Data sent to {% data variables.product.prodname_dotcom %}
70-
71-
After you configure content exclusion, the client (for example, the {% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_vscode_shortname %}) sends the current repository URL to the {% data variables.product.prodname_dotcom %} server so that the server can return the correct policy to the client. These URLs are not logged anywhere.
72-
7326
## Configuring content exclusion for your repository
7427

7528
You can use your repository settings to specify content in your repository that {% data variables.product.prodname_copilot %} should ignore.
@@ -235,5 +188,6 @@ You can verify that content exclusions you have configured are working as expect
235188

236189
## Further reading
237190

191+
* [AUTOTITLE](/copilot/concepts/content-exclusion-for-github-copilot)
238192
* [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/reviewing-changes-to-content-exclusions-for-github-copilot)
239193
* [Configuring content exclusion for {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/ide/visual-studio-github-copilot-admin?view=vs-2022#configure-content-exclusion) in the Microsoft Learn documentation

content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,5 @@ Organization and repository settings include the ability to exclude content from
7272
{% data reusables.copilot.more-details-content-exclusion-logs %}
7373

7474
{% endif %}
75+
76+
* [AUTOTITLE](/copilot/concepts/content-exclusion-for-github-copilot)

0 commit comments

Comments
 (0)