From 8b7b1cc4723ea75178ff71e6c77e2f667d7ca662 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 24 May 2024 10:10:14 +0200 Subject: [PATCH] docs: Update necessary permissions for the GitHub token --- README.Rmd | 4 ++-- README.md | 10 ++++------ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.Rmd b/README.Rmd index d51ff69..350d1d7 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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 diff --git a/README.md b/README.md index 0e74ec2..9ec3806 100644 --- a/README.md +++ b/README.md @@ -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