Skip to content

Commit

Permalink
Merge pull request #35056 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Oct 23, 2024
2 parents ce11601 + bd6cb73 commit 62f7d98
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ redirect_from:

{% data variables.product.prodname_copilot %}'s ability to answer natural language questions, in the context of a {% data variables.product.prodname_dotcom %} repository, is improved when the repository has been indexed for semantic code search.

Indexing repositories is not a requirement and will not affect responses to questions about information in pull requests, issues, discussions, or commits. However, indexing can help {% data variables.product.prodname_copilot_chat_short %} answer questions that relate directly to the code within a repository.
Indexing repositories for {% data variables.product.prodname_copilot_chat_short %} is not a requirement and will not affect responses to questions about information in knowledge bases, pull requests, issues, discussions, or commits. However, indexing is for search purposes and can help {% data variables.product.prodname_copilot_chat_short %} answer questions that relate directly to the code within a repository. **{% data variables.product.prodname_copilot_chat_short %} will not use your indexed repository for model training.**

The indexing status of a repository is displayed on {% data variables.product.github %} when you start a conversation that has a repository context. You can index the repository if it has not been indexed yet.

After you index a repository it is automatically re-indexed every time a change is pushed to the repository.

## Indexing limits

Your {% data variables.product.prodname_copilot %} subscription plan determines your indexing limits.

{% rowheaders %}

| | {% data variables.product.prodname_copilot_individuals_short %} | {% data variables.product.prodname_copilot_business_short %} | {% data variables.product.prodname_copilot_enterprise_short %} |
Expand All @@ -32,6 +34,22 @@ After you index a repository it is automatically re-indexed every time a change

{% endrowheaders %}

{% ifversion ghec %}
If you have a seat on the {% data variables.product.prodname_copilot_enterprise_short %} (CE) plan, you do not have a limit on the number of repositories you can index. You can index repositories from any organization you have access to, regardless of whether the organization is subject to an indexing limit.
{% endif %}

{% ifversion ghec or fpt %}
If you have a seat on the {% data variables.product.prodname_copilot_business_short %} (CB) plan, you are subject to the indexing limit for your organization. You cannot index additional repositories once your organization reaches the repository limit, but you can still benefit from the indexes created by other users.
{% endif %}

{% ifversion fpt %}
If you have a {% data variables.product.prodname_copilot_individuals_short %} (CI) plan, you are subject to an indexing limit and can index any repository that you belong to. However, you can still benefit from the indexes created by other users without affecting your limit.
{% endif %}

Both CE and CB plans can apply content exclusions to control the behavior of {% data variables.product.prodname_copilot %} for the {% data variables.product.prodname_copilot_short %} seats they manage. For more information, see "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/excluding-content-from-github-copilot)." However, CI users can still index any repository they have access to, regardless of the content exclusion policies set by the organization.

> [!WARNING] Indexing is permanent for each repository unless the repository itself is deleted. Use caution when selecting a repository to index. Repository indexing cannot be canceled once it starts.
## Indexing a repository

1. On {% data variables.product.github %}, browse to the repository you want to index.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ Repository administrators{% ifversion ghec%}, organization owners, and enterpris

### Availability of content exclusions

| Tool | Code completion support | {% data variables.product.prodname_copilot_chat_short %} support |
|--------|:--------:|:--------:|
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| JetBrains IDEs | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable |
| Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable |
| The {% data variables.product.github %} website | Not applicable | {% octicon "x" aria-label="Not supported" %} |
| Tool | Code completion support | {% data variables.product.prodname_copilot_chat_short %} support |
|-------------------------------------------------|:---------------------------------------------:|:----------------------------------------------------------------:|
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| JetBrains IDEs | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable |
| Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable |
| The {% data variables.product.github %} website | Not applicable | {% octicon "x" aria-label="Not supported" %} |

### Limitations of content exclusions

Expand Down
55 changes: 37 additions & 18 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@
"highlightjs-curl": "^1.3.0",
"hot-shots": "^10.0.0",
"html-entities": "^2.5.2",
"http-proxy-middleware": "3.0.0",
"http-proxy-middleware": "3.0.3",
"imurmurhash": "^0.1.4",
"is-svg": "5.0.0",
"javascript-stringify": "^2.1.0",
Expand Down
2 changes: 1 addition & 1 deletion src/search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can also query our search endpoint directly at:

## Production deploys

A [GitHub Actions workflow](/.github/workflows/sync-search-elasticsearch.yml) that runs every four hours syncs the search data. This process generates structured data for all pages on the site, compares that data to what's currently on search, then adds, updates, or removes indices based on the diff of the local and remote data, being careful not to create duplicate records and avoiding any unnecessary (and costly) indexing operations.
A [GitHub Actions workflow](/.github/workflows/sync-search-elasticsearch.yml) that runs every twenty four hours syncs the search data. This process generates structured data for all pages on the site, compares that data to what's currently on search, then adds, updates, or removes indices based on the diff of the local and remote data, being careful not to create duplicate records and avoiding any unnecessary (and costly) indexing operations.

The workflow runs are only accessible to GitHub employees using internal resources.

Expand Down

0 comments on commit 62f7d98

Please sign in to comment.