Skip to content

Commit f9930b5

Browse files
hubwritermchammer01sophiethekingam-steadguntrip
authored
Copilot content exclusion: extend support to VS/IJ/neovim (#45825)
Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Steve Guntrip <stevecat@github.com> Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Co-authored-by: Melissa Xie <mxie@users.noreply.github.com> Co-authored-by: Andy Feller <andyfeller@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Kelly Arwine <kellyarwine@github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: Max Schaefer <54907921+max-schaefer@users.noreply.github.com> Co-authored-by: Tiferet Gazit <tiferet@github.com> Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com> Co-authored-by: Andrew Eisenberg <aeisenberg@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Annelisa Stephan <meowius@github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: isaacmbrown <isaacmbrown@github.com> Co-authored-by: Greg Padak <gpadak@github.com>
1 parent 08388ca commit f9930b5

File tree

6 files changed

+40
-14
lines changed

6 files changed

+40
-14
lines changed
Loading

content/copilot/managing-copilot-business/configuring-content-exclusions-for-github-copilot.md

+24-10
Original file line numberDiff line numberDiff line change
@@ -253,32 +253,46 @@ If you are an organization owner, you can check any changes that have been made
253253

254254
When you change {% data variables.product.prodname_copilot_short %}'s content exclusions you can check that the setting blocks {% data variables.product.prodname_copilot_short %} from suggesting code in the specified files.
255255

256-
1. In {% data variables.product.prodname_vscode_shortname %}, open a file that you expect to be affected by your content exclusions.
256+
To confirm that {% data variables.product.prodname_copilot_short %} is disabled for a file, open the file in the editor and start typing a line of code, such as a comment. Normally you would see a code completion suggestion from {% data variables.product.prodname_copilot_short %} as you type. If {% data variables.product.prodname_copilot_short %} is disabled by a content exclusion, code completion suggestions will not be offered, and the contents of the file will not be used to generate suggestions in other files.
257+
258+
### Checking settings changes in your IDE
259+
260+
If you are working in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode_shortname %}, or a supported JetBrains IDE, the {% data variables.product.prodname_copilot_short %} icon indicates when {% data variables.product.prodname_copilot_short %} has been disabled by a content exclusion.
261+
262+
1. Open a file that you expect to be affected by your content exclusions.
257263

258264
If a {% data variables.product.prodname_copilot_short %} content exclusion applies to this file, the {% data variables.product.prodname_copilot_short %} icon in the status bar has a diagonal line through it.
259265

260-
![Screenshot of the {% data variables.product.prodname_copilot_short %} disabled icon in the {% data variables.product.prodname_vscode_shortname %} toolbar.](/assets/images/help/copilot/copilot-disabled-for-repo.png)
266+
1. Hover over this icon. A popup message tells you whether an organization or the parent repository disabled {% data variables.product.prodname_copilot_short %} for this file.
261267

262-
1. Click the icon to see a dropdown menu with information about the content exclusions that apply to this file.
268+
![Screenshot of the {% data variables.product.prodname_copilot_short %} disabled popup in the {% data variables.product.prodname_vscode_shortname %} toolbar.](/assets/images/help/copilot/copilot-disabled-for-repo.png)
263269

264-
![Screenshot of the dropdown menu showing why a file has been excluded from {% data variables.product.prodname_copilot_short %}.](/assets/images/help/copilot/copilot-disabled-for-this-file.png)
270+
{% note %}
265271

266-
{% note %}
272+
**Note**: In {% data variables.product.prodname_vs %} and {% data variables.product.prodname_vscode_shortname %} you can display the log for the {% data variables.product.prodname_copilot_short %} extension to see details of content exclusions without having to hover over the {% data variables.product.prodname_copilot_short %} icon. For more information, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment?tool=vscode)."
267273

268-
**Note**: Clicking **Open logs** in this menu displays the log for {% data variables.product.prodname_copilot %} in which details of all excluded files you open are recorded.
274+
{% endnote %}
269275

270-
{% endnote %}
276+
### Propagating content exclusion changes to your IDE
271277

272-
1. You can confirm that {% data variables.product.prodname_copilot_short %} is disabled for this file by starting to type a line of code, such as a comment. Normally you would see a code completion suggestion from {% data variables.product.prodname_copilot_short %} as you type. However, if this file is affected by a content exclusions setting you will not see any suggestions.
278+
If you are working in neovim, content exclusions are fetched from {% data variables.product.prodname_dotcom %} each time you open a file. However, if you are working in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode_shortname %}, or a supported JetBrains IDE, you may have to wait up to 30 minutes to see the effect of a settings change. Alternatively, you can manually reload the content exclusion settings into your IDE.
273279

274-
### Propagating content exclusion changes to {% data variables.product.prodname_vscode_shortname %}
280+
To reload content exclusions into {% data variables.product.prodname_vs %}, close and reopen the application.
275281

276-
If you opened a file in {% data variables.product.prodname_vscode_shortname %} before you changed the content exclusions, you may need to reload the window in {% data variables.product.prodname_vscode_shortname %} to see the effect of the settings change.
282+
To reload content exclusions into {% data variables.product.prodname_vscode_shortname %}:
277283

278284
1. Access the Command Palette. For example, by pressing <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux).
279285
1. Type: `reload`.
280286
1. Select **Developer: Reload Window**.
281287

288+
To reload content exclusions into your JetBrains IDE, either close and reopen the application, or log out of {% data variables.product.prodname_dotcom %} and then log back in, as follows.
289+
290+
1. Click the {% data variables.product.prodname_copilot_short %} icon in the status bar and select **Logout from {% data variables.product.prodname_dotcom %}**.
291+
1. The {% data variables.product.prodname_copilot_short %} icon in the status bar will now have a diagonal line through it. Click it and select **Login to {% data variables.product.prodname_dotcom %}**.
292+
1. The "Sign in to {% data variables.product.prodname_dotcom %}" message is displayed showing a device code. Click **Copy and Open**.
293+
1. On the "Device Activation" page, paste in the device code and click **Continue**.
294+
1. On the next page, click **Authorize {% data variables.product.prodname_copilot %} Plugin**.
295+
282296
## Further reading
283297

284298
- "[AUTOTITLE](/copilot/managing-copilot-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business)"

content/copilot/managing-copilot-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,8 @@ Audit logs for {% data variables.product.prodname_copilot_business_short %} can
3535

3636
## Searching audit log events for {% data variables.product.prodname_copilot_business_short %}
3737

38-
You can search for any of the {% data variables.product.prodname_copilot %} audit log events using the `action` qualifier, and the `copilot` category. For example, searching `action:copilot.cfb_seat_assignment_created` will show you events related to a {% data variables.product.prodname_copilot_business_short %} seat being assigned to a new user. Alternatively, you can review all of the {% data variables.product.prodname_copilot %} audit log events for your organization{% ifversion ghec %} or enterprise{% endif %} by searching for `action:copilot`. For a full list of {% data variables.product.prodname_copilot %} audit log events, see{% ifversion ghec %} "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#copilot)" or{% endif %} "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization#copilot)."
38+
You can search for any of the {% data variables.product.prodname_copilot %} audit log events using the `action` qualifier, and the `copilot` category. For example, searching `action:copilot.cfb_seat_assignment_created` will show you events related to a {% data variables.product.prodname_copilot_business_short %} seat being assigned to a new user.
39+
40+
Alternatively, you can review all of the {% data variables.product.prodname_copilot %} audit log events for your organization{% ifversion ghec %} or enterprise{% endif %} by searching for `action:copilot`.
41+
42+
For a full list of {% data variables.product.prodname_copilot %} audit log events, see{% ifversion ghec %} "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#copilot)" or{% endif %} "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization#copilot)."

content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ When a file is affected by a content exclusion setting, {% data variables.produc
3333

3434
{% data reusables.copilot.content-exclusions-scope %}
3535

36-
{% data reusables.copilot.content-exclusions-delay %} For more information, see "[AUTOTITLE](/copilot/managing-copilot-business/configuring-content-exclusions-for-github-copilot#checking-the-affect-of-a-settings-change)."
36+
{% data reusables.copilot.content-exclusions-delay %} For more information, see "[AUTOTITLE](/copilot/managing-copilot-business/configuring-content-exclusions-for-github-copilot#propagating-content-exclusion-changes-to-your-ide)."
3737

3838
{% note %}
3939

Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
Excluding content from {% data variables.product.prodname_copilot %} is currently in public beta and is subject to change.
1+
{% note %}
2+
3+
**Notes**:
4+
5+
- Excluding content from {% data variables.product.prodname_copilot %} is currently in public beta and is subject to change.
6+
- Content exclusion currently only affects code completion. {% data variables.product.prodname_copilot_chat %} is not affected by these settings.
7+
- This feature is supported in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, JetBrains IDEs, and neovim. For details of supported JetBrains IDEs, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot?tool=jetbrains#prerequisites)."
8+
9+
{% endnote %}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
After you add or change content exclusions it can take up to 30 minutes for this to take effect in {% data variables.product.prodname_vscode_shortname %}. You can apply changes immediately by reloading the window in {% data variables.product.prodname_vscode_shortname %}.
1+
After you add or change content exclusions it can take up to 30 minutes for this to take effect in IDEs where the settings are already loaded. You can apply changes to your own IDE forcing it to reload the content exclusion settings.

0 commit comments

Comments
 (0)