This repository was archived by the owner on Sep 30, 2024. It is now read-only.
[docs] Support GitHub fine-grained access tokens with limitations#50274
Merged
Conversation
pjlast
commented
Apr 3, 2023
| | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | ||
| | [Sync private repositories](#private-repositories) | `repo` | | ||
| | [Sync repository permissions][permissions] | `repo` | | ||
| | [Repository permissions caching][permissions-caching] | `repo`, `write:org` | |
Contributor
Author
There was a problem hiding this comment.
I'm removing this line because it is not applicable to Personal Access Tokens. It only applies to OAuth tokens, as that's where this setting is used.
Contributor
|
Codenotify: Notifying subscribers in CODENOTIFY files for diff 3289d1d...1277a21.
|
kopancek
reviewed
Apr 3, 2023
kopancek
reviewed
Apr 3, 2023
| The `repositoryQuery` option `"public"` is valuable in that it allows sourcegraph to sync all public repositories, however, it does not return whether or not a repo is archived. This can result in archived repos appearing in normal search. You can see an example of what is returned by the GitHub API for a query to "public" [here](https://docs.github.com/en/rest/reference/repos#list-public-repositories). | ||
|
|
||
| If you would like to sync all public repositories while omitting archived repos, consider generating a GitHub token with access to only public repositories, then use `respositoryQuery` with option `affiliated` and an `exclude` argument with option `public` as seen in the example below: | ||
| If you would like to sync all public repositories while omitting archived repos, consider generating a GitHub token with access to only public repositories, then use `repositoryQuery` with option `affiliated` and an `exclude` argument with option `public` as seen in the example below: |
kopancek
approved these changes
Apr 3, 2023
kopancek
left a comment
Contributor
There was a problem hiding this comment.
Looks good, added 1 suggestion to change or to and, sounds better to me that way, since both are not supported.
vdavid
approved these changes
Apr 3, 2023
vdavid
left a comment
Contributor
There was a problem hiding this comment.
Looks good; if you want to invest a bit more time in this, I think a short guide to answer the question "Which one shall I use, a Personal or a fine-grained access token? What are the pros and cons for each?" would help customers big time. Part of the answer is in there already, but I suggest extracting and completing it.
sashaostrikov
approved these changes
Apr 3, 2023
mrnugget
approved these changes
Apr 3, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add docs to explain what is supported by fine-grained access tokens.
Test plan
I verified that repository and permissions syncing does work, and that
repositoryQueryand Batch Changes does not work.