Add note that GitHub PATs expire, with a default expiration of 30 days.

Fixes #36.
r-lib · Aug 15, 2024 · 67c05f7 · 67c05f7
1 parent 9c4af4d
commit 67c05f7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/aaa-doc.R b/R/aaa-doc.R
@@ -57,7 +57,8 @@
 #'
 #' To set up password-less authentication to GitHub:
 #' 1. Create a personal access token (PAT). See
-#' https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token.
+#' <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>.
+#' Note that personal access tokens can expire, and the default expiration time is 30 days.
 #' 2. Call `gitcreds_set()` and give this token as the password.
 #' 3. Run `gitcreds_get(use_cache = FALSE)` to check that the new
 #' PAT is set up. To see the token, you can run

diff --git a/man/gitcreds_get.Rd b/man/gitcreds_get.Rd