Skip to content

Commit

Permalink
docs: Update necessary permissions for the GitHub token
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed May 24, 2024
1 parent 5264f0b commit 8b7b1cc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ remotes::install_github("ropensci-org/gitcellar")

You will need a GitHub Personal Access Token (PAT).
See [gh docs on the topic](https://gh.r-lib.org/articles/managing-personal-access-tokens.html).
As long as you're an owner of the organisation you're trying to back up, absolutely no permissions are required for your PAT.
You will only need to add the `repos` scope if you wish to automatically include private repositories in the list of repos to back up. Note however that there is a workaround using the `extra_repos` argument in `download_organization_repos()`.
You need to be an owner of the organisation you're trying to back up.
[Scopes needed](https://docs.github.com/en/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom): `repo` and `admin:org`.

## Example

Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,10 @@ remotes::install_github("ropensci-org/gitcellar")

You will need a GitHub Personal Access Token (PAT). See [gh docs on the
topic](https://gh.r-lib.org/articles/managing-personal-access-tokens.html).
As long as you’re an owner of the organisation you’re trying to back up,
absolutely no permissions are required for your PAT. You will only need
to add the `repos` scope if you wish to automatically include private
repositories in the list of repos to back up. Note however that there is
a workaround using the `extra_repos` argument in
`download_organization_repos()`.
You need to be an owner of the organisation you’re trying to back up.
[Scopes
needed](https://docs.github.com/en/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom):
`repo` and `admin:org`.

## Example

Expand Down

0 comments on commit 8b7b1cc

Please sign in to comment.