Настройка исключений содержимого для GitHub Copilot

About configuring content exclusions

You may want to prevent certain files from being available to GitHub Copilot. You can configure GitHub Copilot so that it ignores these files. You do this by specifying paths to excluded content in the settings for your repository or organization.

When you specify content exclusions it has two effects:

• The content of the affected files will not be used by GitHub Copilot to inform the code completion suggestions it makes in other files.
• GitHub Copilot code completion will not be available in the affected files.

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. For more information, see "Propagating content exclusion changes to your IDE."

Limitations

• Excluding content from GitHub Copilot currently only affects code completion. GitHub Copilot Chat is not affected by these settings.
• Content exclusion prevents Copilot directly accessing the content of excluded files. Copilot may draw information about non-excluded files from semantic information provided by the IDE - for example, type information, or hover-over definitions for symbols used in code. It's possible that the IDE may derive this information from excluded files.

What can you exclude?

When you specify content exclusion in the settings for a repository, you can only exclude files in that repository.

When you specify content exclusion in the settings for an organization, you can exclude files in any Git-based repository hosted on GitHub.com or anywhere that can be accessed using any of the following syntaxes:

http[s]://host.xz[:port]/path/to/repo.git/

git://host.xz[:port]/path/to/repo.git/

[user@]host.xz:path/to/repo.git/

ssh://[user@]host.xz[:port]/path/to/repo.git/

Who is affected by a content exclusion setting?

GitHub Copilot content exclusion settings do not apply to everyone who uses Copilot.

A content exclusion setting only applies to people who have been granted a seat as part of a GitHub Copilot Business or GitHub Copilot Enterprise subscription and are members of the same organization in which the content exclusion is configured. Other users who can access the specified files will not be affected by the content exclusion and will still see code completion suggestions.

All exclusions, whether they are defined in repository settings or in organization settings, apply to all members of the organization who have been granted a Copilot seat as part of a Copilot Business subscription.

Data sent to GitHub

After you configure content exclusion, the client (for example, the Copilot extension for VS Code) sends the current repository URL to the GitHub server so that the server can return the correct policy to the client. URLs sent to the server in this way are not logged anywhere.

Configuring content exclusions for your repository

You can use your repository settings to specify content in your repository that GitHub Copilot should ignore.

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the "Code & automation" section of the side bar, click Copilot.

   If your repository inherits any exclusions from its parent organization, you'll see a gray box at the top of the page containing details of these exclusions. You cannot edit these settings.

4. In the box under "Paths to exclude in this repository," enter the paths to files from which Copilot should be excluded.

   

   Use the format: - "/PATH/TO/DIRECTORY/OR/FILE", with each path on a separate line. You can add comments by starting a line with #.

   You can use fnmatch pattern matching notation to specify file paths. For more information, see "File" in the ruby-doc.org documentation.

   Note: Patterns are case insensitive.

Example of paths specified in the repository settings

# Ignore the `/src/some-dir/kernel.rs` file in this repository.
- "/src/some-dir/kernel.rs"

# Ignore files called `secrets.json` anywhere in this repository.
- "secrets.json"

# Ignore all files whose names begin `secret` anywhere in this repository.
- "secret*"

# Ignore files whose names end `.cfg` anywhere in this repository.
- "*.cfg"

# Ignore all files in or below the `/scripts` directory of this repository.
- "/scripts/**"

- "/src/some-dir/kernel.rs"

- "secrets.json"

- "secret*"

- "*.cfg"

- "/scripts/**"

# Ignore the `/src/some-dir/kernel.rs` file in this repository.
- "/src/some-dir/kernel.rs"

# Ignore files called `secrets.json` anywhere in this repository.
- "secrets.json"

# Ignore all files whose names begin `secret` anywhere in this repository.
- "secret*"

# Ignore files whose names end `.cfg` anywhere in this repository.
- "*.cfg"

# Ignore all files in or below the `/scripts` directory of this repository.
- "/scripts/**"

Configuring content exclusions for your organization

You can use your organization settings to specify content, in any repository, that GitHub Copilot should ignore.

1. In the upper-right corner of GitHub.com, select your profile photo, then click Your organizations.

   

2. Next to the organization, click Settings.

3. In the left sidebar, click Copilot then click Content exclusion.

4. In the box under "Repositories and paths to exclude," enter details of where Copilot should be excluded.

   For each repository in which you want files to be excluded from Copilot, enter a reference to the repository on one line, followed by paths to locations within the repository, with each path on a separate line. Use the following format:

   REPOSITORY-REFERENCE:
     - "/PATH/TO/DIRECTORY/OR/FILE"
     - "/PATH/TO/DIRECTORY/OR/FILE"
     - ...
   

   The following syntax is supported for REPOSITORY-REFERENCE:

   http[s]://host.xz[:port]/path/to/repo.git/
   
   git://host.xz[:port]/path/to/repo.git/
   
   [user@]host.xz:path/to/repo.git/
   
   ssh://[user@]host.xz[:port]/path/to/repo.git/
   

   Notes:

   • The user@ and :port parts of the REPOSITORY-REFERENCE are ignored in the calculation of which paths to ignore for a repository.
   • Each repository reference can contain a single * wildcard. For example, https://github.com/octo-org/* matches all repositories in the octo-org organization.

   You can use fnmatch pattern matching notation to specify file paths. For more information, see "File" in the ruby-doc.org documentation.

   Note: Patterns are case insensitive.

Example of repositories and paths in organization settings

# Ignore all `.env` files at any path, in any repository.
# This setting applies to all repositories, not just to those on GitHub.com.
# This could also have been written on a single line as:
#
# "*": ["**/.env"]
"*":
  - "**/.env"

# In the `octo-repo` repository in this organization:
octo-repo:
  # Ignore the `/src/some-dir/kernel.rs` file.
  - "/src/some-dir/kernel.rs"

# In the `primer/react` repository on GitHub:
https://github.com/primer/react.git:
  # Ignore files called `secrets.json` anywhere in this repository.
  - "secrets.json"
  # Ignore files called `temp.rb` in or below the `/src` directory.
  - "/src/**/temp.rb"

# In the `copilot` repository of any GitHub organization:
git@github.com:*/copilot:
  # Ignore any files in or below the `/__tests__` directory.
  - "/__tests__/**"
  # Ignore any files in the `/scripts` directory.
  - "/scripts/*"

# In the `gitlab-org/gitlab-runner` repository on GitLab:
git@gitlab.com:gitlab-org/gitlab-runner.git:
  # Ignore the `/main_test.go` file.
  - "/main_test.go"
  # Ignore any files with names beginning `server` or `session`, anywhere in this repository.
  - "{server,session}*"
  # Ignore any files with names ending `.md` or `.mk`, anywhere in this repository.
  - "*.m[dk]"
  # Ignore files directly within directories such as `packages` or `packaged`, anywhere in this repository.
  - "**/package?/*"
  # Ignore files in or below any `security` directories, anywhere in this repository.
  - "**/security/**"

"*":
  - "**/.env"

octo-repo:

  - "/src/some-dir/kernel.rs"

https://github.com/primer/react.git:

  - "secrets.json"

  - "/src/**/temp.rb"

git@github.com:*/copilot:

  - "/__tests__/**"

  - "/scripts/*"

git@gitlab.com:gitlab-org/gitlab-runner.git:

  - "/main_test.go"

  - "{server,session}*"

  - "*.m[dk]"

  - "**/package?/*"

  - "**/security/**"

# Ignore all `.env` files at any path, in any repository.
# This setting applies to all repositories, not just to those on GitHub.com.
# This could also have been written on a single line as:
#
# "*": ["**/.env"]
"*":
  - "**/.env"

# In the `octo-repo` repository in this organization:
octo-repo:
  # Ignore the `/src/some-dir/kernel.rs` file.
  - "/src/some-dir/kernel.rs"

# In the `primer/react` repository on GitHub:
https://github.com/primer/react.git:
  # Ignore files called `secrets.json` anywhere in this repository.
  - "secrets.json"
  # Ignore files called `temp.rb` in or below the `/src` directory.
  - "/src/**/temp.rb"

# In the `copilot` repository of any GitHub organization:
git@github.com:*/copilot:
  # Ignore any files in or below the `/__tests__` directory.
  - "/__tests__/**"
  # Ignore any files in the `/scripts` directory.
  - "/scripts/*"

# In the `gitlab-org/gitlab-runner` repository on GitLab:
git@gitlab.com:gitlab-org/gitlab-runner.git:
  # Ignore the `/main_test.go` file.
  - "/main_test.go"
  # Ignore any files with names beginning `server` or `session`, anywhere in this repository.
  - "{server,session}*"
  # Ignore any files with names ending `.md` or `.mk`, anywhere in this repository.
  - "*.m[dk]"
  # Ignore files directly within directories such as `packages` or `packaged`, anywhere in this repository.
  - "**/package?/*"
  # Ignore files in or below any `security` directories, anywhere in this repository.
  - "**/security/**"

Reviewing changes to the content exclusion settings

If you are an organization owner, you can check any changes that have been made to content exclusions.

1. Open the "Content exclusion" page in the settings for your organization (described here), or the settings for a repository (described here).

2. Scroll to the bottom of the page.

   You will see the name of the person who last changed the settings, and information about when they made this change.

3. Click the time of the last change.

   

   Note: The time of the last change is only a link if you are an organization owner.

   The "Audit log" page for the organization is displayed, showing the most recently logged occurrences of the copilot.content_exclusion_changed action.

   If you clicked through from a repository settings page, the audit log is filtered to show only changes to content exclusions for that repository.

4. Click the ellipsis (...) at the end of each entry to see more details.

   If the "excluded_paths" entry is truncated, hover over the truncated value to show the full entry. This displays the content of the exclusion settings after the change was saved.

   

Checking the effect of a settings change

When you change Copilot's content exclusions you can check that the setting blocks Copilot from suggesting code in the specified files.

To confirm that Copilot 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 Copilot as you type. If Copilot is disabled by a content exclusion, code completion suggestions will not be offered, and the file's contents will not be used to generate suggestions in other files.

Checking settings changes in your IDE

If you are working in Visual Studio, VS Code, or a supported JetBrains IDE, the Copilot icon indicates when Copilot has been disabled by a content exclusion.

1. Open a file that you expect to be affected by your content exclusions.

   If a Copilot content exclusion applies to this file, the Copilot icon in the status bar has a diagonal line through it.

2. Hover over this icon. A popup message tells you whether an organization or the parent repository disabled Copilot for this file.

   

Propagating content exclusion changes to your IDE

If you are working in Neovim, content exclusions are fetched from GitHub each time you open a file. However, if you are working in Visual Studio, VS Code, 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.

To reload content exclusions into Visual Studio, close and reopen the application.

To reload content exclusions into VS Code:

1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
2. Type: reload.
3. Select Developer: Reload Window.

To reload content exclusions into your JetBrains IDE, either close and reopen the application, or log out of GitHub and then log back in, as follows.

1. Click the Copilot icon in the status bar and select Logout from GitHub.
2. The Copilot icon in the status bar will now have a diagonal line through it. Click it and select Login to GitHub.
3. The "Sign in to GitHub" message is displayed showing a device code. Click Copy and Open.
4. On the "Device Activation" page, paste in the device code and click Continue.
5. On the next page, click Authorize GitHub Copilot Plugin.

Further reading

• "Reviewing your organization's audit logs for Copilot Business"