Skip to content

Commit 92c89fd

Browse files
committed
Correct the scopes required for --source-token.
1 parent 513808c commit 92c89fd

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ From a machine with access to both GitHub.com and GitHub Enterprise Server use t
2424

2525
**Optional Arguments:**
2626
* `--cache-dir` - A temporary directory in which to store data downloaded from GitHub.com before it is uploaded to GitHub Enterprise Server. If not specified a directory next to the sync tool will be used.
27-
* `--source-token` - A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting. If provided, it should have the `public_repo` scope.
27+
* `--source-token` - A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting. The token does not need to have any scopes.
2828
* `--destination-repository` - The name of the repository in which to create or update the CodeQL Action. If not specified `github/codeql-action` will be used.
2929
* `--force` - By default the tool will not overwrite existing repositories. Providing this flag will allow it to.
3030

@@ -33,7 +33,7 @@ From a machine with access to GitHub.com use the `./codeql-action-sync pull` com
3333

3434
**Optional Arguments:**
3535
* `--cache-dir` - The directory in which to store data downloaded from GitHub.com. If not specified a directory next to the sync tool will be used.
36-
* `--source-token` - A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting. If provided, it should have the `public_repo` scope.
36+
* `--source-token` - A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting. The token does not need to have any scopes.
3737

3838
Next copy the sync tool and cache directory to another machine which has access to GitHub Enterprise Server.
3939

0 commit comments

Comments
 (0)