Skip to content

Commit

Permalink
Add note about GitHub PAT expiration time (#59)
Browse files Browse the repository at this point in the history
* Increase roxygen version from 7.2.3 to 7.3.2

* Add note that GitHub PATs expire, with a default expiration of 30 days. Fixes #36.
  • Loading branch information
melissavanbussel authored Aug 15, 2024
1 parent 6d0cc82 commit cf006f0
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Config/Needs/website: tidyverse/tidytemplate
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.2
SystemRequirements: git
3 changes: 2 additions & 1 deletion R/aaa-doc.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion man/gitcreds-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/gitcreds_get.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cf006f0

Please sign in to comment.