From c9aec1eec8c2e26fd4f12ae02a8e1159bc374ef5 Mon Sep 17 00:00:00 2001 From: Jesse Ross Date: Thu, 14 Oct 2021 07:16:11 -0700 Subject: [PATCH] PAT scope clarification (#657) * clarify necessary scope for gitlab PAT * clarify necessary scope for github PAT * make URL clickable --- R/install-github.R | 3 ++- R/install-gitlab.R | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/R/install-github.R b/R/install-github.R index d512d372..a08f7c3d 100644 --- a/R/install-github.R +++ b/R/install-github.R @@ -15,7 +15,8 @@ #' for more details. #' @param subdir Subdirectory within repo that contains the R package. #' @param auth_token To install from a private repo, generate a personal -#' access token (PAT) in "https://github.com/settings/tokens" and +#' access token (PAT) with at least repo scope in +#' \url{https://github.com/settings/tokens} and #' supply to this argument. This is safer than using a password because #' you can easily delete a PAT without affecting any others. Defaults to #' the `GITHUB_PAT` environment variable. diff --git a/R/install-gitlab.R b/R/install-gitlab.R index 4ed97820..f60c7c61 100644 --- a/R/install-gitlab.R +++ b/R/install-gitlab.R @@ -14,7 +14,8 @@ #' \link{install_gitlab} may work without, omitting it generally #' leads to package restoration errors. #' @param auth_token To install from a private repo, generate a personal access -#' token (PAT) in \url{https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html} and +#' token (PAT) with at least read_api scope in +#' \url{https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html} and #' supply to this argument. This is safer than using a password because you #' can easily delete a PAT without affecting any others. Defaults to the #' GITLAB_PAT environment variable.