From 9f1c938b8aecccf20ae0dab6968e8a82992587e9 Mon Sep 17 00:00:00 2001 From: Lionel Henry Date: Fri, 4 Dec 2020 13:09:33 +0100 Subject: [PATCH 1/2] Use markdown syntax for lifecycle badges --- DESCRIPTION | 2 -- R/ci.R | 2 +- R/github-labels.R | 8 ++++---- R/github.R | 16 ++++++++-------- R/pkgdown.R | 15 ++++++++------- R/release.R | 6 +++--- R/usethis-defunct.R | 2 +- man/ci.Rd | 2 +- man/create_from_github.Rd | 22 +++++++++++----------- man/git_credentials.Rd | 2 +- man/use_github.Rd | 10 +++++----- man/use_github_labels.Rd | 8 ++++---- man/use_github_links.Rd | 6 +++--- man/use_github_release.Rd | 6 +++--- man/use_pkgdown.Rd | 15 ++++++++------- 15 files changed, 61 insertions(+), 61 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 80d07a0e7..4006b5415 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -55,8 +55,6 @@ Suggests: spelling (>= 1.2), styler (>= 1.2.0), testthat (>= 3.0.0) -RdMacros: - lifecycle Encoding: UTF-8 Language: en-US LazyData: true diff --git a/R/ci.R b/R/ci.R index 8f0546463..956ff303a 100644 --- a/R/ci.R +++ b/R/ci.R @@ -2,7 +2,7 @@ #' #' @description #' -#' \lifecycle{soft-deprecated} +#' `r lifecycle::badge("soft-deprecated")` #' #' Some of these functions are now soft-deprecated since the tidyverse team has #' started using [GitHub Actions (GHA)](https://github.com/features/actions) for diff --git a/R/github-labels.R b/R/github-labels.R index 11a7df9ea..fa92d6462 100644 --- a/R/github-labels.R +++ b/R/github-labels.R @@ -22,10 +22,10 @@ #' * `good first issue` indicates a good issue for first-time contributors. #' * `help wanted` indicates that a maintainer wants help on an issue. #' -#' @param repo_spec,host,auth_token \lifecycle{defunct}: These arguments are -#' now deprecated and will be removed in the future. Any input provided via -#' these arguments is not used. The target repo, host, and auth token are all -#' now determined from the current project's Git remotes. +#' @param repo_spec,host,auth_token `r lifecycle::badge("defunct")`: These +#' arguments are now deprecated and will be removed in the future. Any input +#' provided via these arguments is not used. The target repo, host, and auth +#' token are all now determined from the current project's Git remotes. #' @param labels A character vector giving labels to add. #' @param rename A named vector with names giving old names and values giving #' new names. diff --git a/R/github.R b/R/github.R index 2e319ca73..3f8d81a35 100644 --- a/R/github.R +++ b/R/github.R @@ -34,11 +34,11 @@ #' For a hypothetical GitHub Enterprise instance, either #' "https://github.acme.com/api/v3" or "https://github.acme.com" is #' acceptable. -#' @param auth_token,credentials \lifecycle{defunct}: No longer consulted now -#' that usethis uses the gert package for Git operations, instead of git2r; -#' gert relies on the credentials package for auth. The API requests are now -#' authorized with the token associated with the `host`, as retrieved by -#' [gh::gh_token()]. +#' @param auth_token,credentials `r lifecycle::badge("defunct")`: No longer +#' consulted now that usethis uses the gert package for Git operations, +#' instead of git2r; gert relies on the credentials package for auth. The API +#' requests are now authorized with the token associated with the `host`, as +#' retrieved by [gh::gh_token()]. #' #' @export #' @examples @@ -176,9 +176,9 @@ use_github <- function(organisation = NULL, #' an interactive session, the user can confirm which repo to use for the #' links. In a noninteractive session, links are formed using `upstream`. #' -#' @param host,auth_token \lifecycle{defunct}: No longer consulted now that -#' usethis consults the current project's GitHub remotes to get the `host` and -#' then relies on gh to discover an appropriate token. +#' @param host,auth_token `r lifecycle::badge("defunct")`: No longer consulted +#' now that usethis consults the current project's GitHub remotes to get the +#' `host` and then relies on gh to discover an appropriate token. #' @param overwrite By default, `use_github_links()` will not overwrite existing #' fields. Set to `TRUE` to overwrite existing links. #' @export diff --git a/R/pkgdown.R b/R/pkgdown.R index 25349a59a..cdd905698 100644 --- a/R/pkgdown.R +++ b/R/pkgdown.R @@ -10,13 +10,14 @@ #' Learn more about [use_github_action()]. This approach is actively #' maintained, because it is in use across many tidyverse, r-lib, and #' tidymodels packages. -#' * `use_pkgdown_travis()` \lifecycle{soft-deprecated} helps you set up -#' pkgdown for automatic deployment on Travis-CI. This is soft-deprecated, -#' as the tidyverse team has shifted away from Travis-CI and towards GitHub -#' Actions. `use_pkgdown_travis()` creates an empty `gh-pages` branch for -#' the site and prompts about next steps regarding deployment keys and -#' updating your `.travis.yml`. Requires that the current user can push to -#' the primary repo, which must be configured as the `origin` remote. +#' * `use_pkgdown_travis()` `r lifecycle::badge("soft-deprecated")` helps you +#' set up pkgdown for automatic deployment on Travis-CI. This is +#' soft-deprecated, as the tidyverse team has shifted away from Travis-CI +#' and towards GitHub Actions. `use_pkgdown_travis()` creates an empty +#' `gh-pages` branch for the site and prompts about next steps regarding +#' deployment keys and updating your `.travis.yml`. Requires that the +#' current user can push to the primary repo, which must be configured as +#' the `origin` remote. #' #' @seealso #' @param config_file Path to the pkgdown yaml config file diff --git a/R/release.R b/R/release.R index 9209e4cd7..896be1727 100644 --- a/R/release.R +++ b/R/release.R @@ -116,9 +116,9 @@ release_type <- function(version) { #' need to publish the release from GitHub. It also deletes `CRAN-RELEASE` and #' checks that you've pushed all commits to GitHub. #' -#' @param host,auth_token \lifecycle{defunct}: No longer consulted now that -#' usethis allows the gh package to lookup a token based on a URL determined -#' from the current project's GitHub remotes. +#' @param host,auth_token `r lifecycle::badge("defunct")`: No longer consulted +#' now that usethis allows the gh package to lookup a token based on a URL +#' determined from the current project's GitHub remotes. #' @export use_github_release <- function(host = deprecated(), auth_token = deprecated()) { diff --git a/R/usethis-defunct.R b/R/usethis-defunct.R index 82224e6d1..0dd616726 100644 --- a/R/usethis-defunct.R +++ b/R/usethis-defunct.R @@ -103,7 +103,7 @@ deprecate_warn_credentials <- function(whos_asking, details = NULL) { #' #' @description #' -#' \lifecycle{defunct} +#' `r lifecycle::badge("defunct")` #' #' In usethis v2.0.0, usethis switched from git2r to gert (+ credentials) for #' all Git operations. This pair of packages (gert + credentials) is designed to diff --git a/man/ci.Rd b/man/ci.Rd index 750cd09ba..30731e877 100644 --- a/man/ci.Rd +++ b/man/ci.Rd @@ -42,7 +42,7 @@ of R, change the tag from \code{latest} to the version you want, e.g. \verb{rocker/r-ver:3.5.3}.} } \description{ -\lifecycle{soft-deprecated} +\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} Some of these functions are now soft-deprecated since the tidyverse team has started using \href{https://github.com/features/actions}{GitHub Actions (GHA)} for diff --git a/man/create_from_github.Rd b/man/create_from_github.Rd index 9f7dbca89..3605604e0 100644 --- a/man/create_from_github.Rd +++ b/man/create_from_github.Rd @@ -73,17 +73,17 @@ For a hypothetical GitHub Enterprise instance, either "https://github.acme.com/api/v3" or "https://github.acme.com" is acceptable.} -\item{auth_token}{\lifecycle{defunct}: No longer consulted now -that usethis uses the gert package for Git operations, instead of git2r; -gert relies on the credentials package for auth. The API requests are now -authorized with the token associated with the \code{host}, as retrieved by -\code{\link[gh:gh_token]{gh::gh_token()}}.} - -\item{credentials}{\lifecycle{defunct}: No longer consulted now -that usethis uses the gert package for Git operations, instead of git2r; -gert relies on the credentials package for auth. The API requests are now -authorized with the token associated with the \code{host}, as retrieved by -\code{\link[gh:gh_token]{gh::gh_token()}}.} +\item{auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +consulted now that usethis uses the gert package for Git operations, +instead of git2r; gert relies on the credentials package for auth. The API +requests are now authorized with the token associated with the \code{host}, as +retrieved by \code{\link[gh:gh_token]{gh::gh_token()}}.} + +\item{credentials}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +consulted now that usethis uses the gert package for Git operations, +instead of git2r; gert relies on the credentials package for auth. The API +requests are now authorized with the token associated with the \code{host}, as +retrieved by \code{\link[gh:gh_token]{gh::gh_token()}}.} } \description{ Creates a new local project and Git repository from a repo on GitHub, by diff --git a/man/git_credentials.Rd b/man/git_credentials.Rd index 39b40080e..ae69418c1 100644 --- a/man/git_credentials.Rd +++ b/man/git_credentials.Rd @@ -20,7 +20,7 @@ use_git_credentials(credentials = deprecated()) These functions raise a warning and return an invisible \code{NULL}. } \description{ -\lifecycle{defunct} +\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}} In usethis v2.0.0, usethis switched from git2r to gert (+ credentials) for all Git operations. This pair of packages (gert + credentials) is designed to diff --git a/man/use_github.Rd b/man/use_github.Rd index 0b32de4af..ffece4771 100644 --- a/man/use_github.Rd +++ b/man/use_github.Rd @@ -33,11 +33,11 @@ For a hypothetical GitHub Enterprise instance, either "https://github.acme.com/api/v3" or "https://github.acme.com" is acceptable.} -\item{auth_token, credentials}{\lifecycle{defunct}: No longer consulted now -that usethis uses the gert package for Git operations, instead of git2r; -gert relies on the credentials package for auth. The API requests are now -authorized with the token associated with the \code{host}, as retrieved by -\code{\link[gh:gh_token]{gh::gh_token()}}.} +\item{auth_token, credentials}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +consulted now that usethis uses the gert package for Git operations, +instead of git2r; gert relies on the credentials package for auth. The API +requests are now authorized with the token associated with the \code{host}, as +retrieved by \code{\link[gh:gh_token]{gh::gh_token()}}.} } \description{ \code{use_github()} takes a local project and: diff --git a/man/use_github_labels.Rd b/man/use_github_labels.Rd index 3631e9386..44d1a87ff 100644 --- a/man/use_github_labels.Rd +++ b/man/use_github_labels.Rd @@ -35,10 +35,10 @@ tidy_label_colours() tidy_label_descriptions() } \arguments{ -\item{repo_spec, host, auth_token}{\lifecycle{defunct}: These arguments are -now deprecated and will be removed in the future. Any input provided via -these arguments is not used. The target repo, host, and auth token are all -now determined from the current project's Git remotes.} +\item{repo_spec, host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: These +arguments are now deprecated and will be removed in the future. Any input +provided via these arguments is not used. The target repo, host, and auth +token are all now determined from the current project's Git remotes.} \item{labels}{A character vector giving labels to add.} diff --git a/man/use_github_links.Rd b/man/use_github_links.Rd index 2dde83972..0a89ea2bd 100644 --- a/man/use_github_links.Rd +++ b/man/use_github_links.Rd @@ -11,9 +11,9 @@ use_github_links( ) } \arguments{ -\item{host, auth_token}{\lifecycle{defunct}: No longer consulted now that -usethis consults the current project's GitHub remotes to get the \code{host} and -then relies on gh to discover an appropriate token.} +\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer consulted +now that usethis consults the current project's GitHub remotes to get the +\code{host} and then relies on gh to discover an appropriate token.} \item{overwrite}{By default, \code{use_github_links()} will not overwrite existing fields. Set to \code{TRUE} to overwrite existing links.} diff --git a/man/use_github_release.Rd b/man/use_github_release.Rd index 76b24488f..acb9fb280 100644 --- a/man/use_github_release.Rd +++ b/man/use_github_release.Rd @@ -7,9 +7,9 @@ use_github_release(host = deprecated(), auth_token = deprecated()) } \arguments{ -\item{host, auth_token}{\lifecycle{defunct}: No longer consulted now that -usethis allows the gh package to lookup a token based on a URL determined -from the current project's GitHub remotes.} +\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer consulted +now that usethis allows the gh package to lookup a token based on a URL +determined from the current project's GitHub remotes.} } \description{ Creates a \strong{draft} GitHub release for the current package using the current diff --git a/man/use_pkgdown.Rd b/man/use_pkgdown.Rd index 8b3a87d44..12901e112 100644 --- a/man/use_pkgdown.Rd +++ b/man/use_pkgdown.Rd @@ -26,13 +26,14 @@ build and deploy your pkgdown site whenever you push changes to GitHub. Learn more about \code{\link[=use_github_action]{use_github_action()}}. This approach is actively maintained, because it is in use across many tidyverse, r-lib, and tidymodels packages. -\item \code{use_pkgdown_travis()} \lifecycle{soft-deprecated} helps you set up -pkgdown for automatic deployment on Travis-CI. This is soft-deprecated, -as the tidyverse team has shifted away from Travis-CI and towards GitHub -Actions. \code{use_pkgdown_travis()} creates an empty \code{gh-pages} branch for -the site and prompts about next steps regarding deployment keys and -updating your \code{.travis.yml}. Requires that the current user can push to -the primary repo, which must be configured as the \code{origin} remote. +\item \code{use_pkgdown_travis()} \ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} helps you +set up pkgdown for automatic deployment on Travis-CI. This is +soft-deprecated, as the tidyverse team has shifted away from Travis-CI +and towards GitHub Actions. \code{use_pkgdown_travis()} creates an empty +\code{gh-pages} branch for the site and prompts about next steps regarding +deployment keys and updating your \code{.travis.yml}. Requires that the +current user can push to the primary repo, which must be configured as +the \code{origin} remote. } } \seealso{ From d03e9913e7c007636daa12db38f9c94febef6b9a Mon Sep 17 00:00:00 2001 From: Hadley Wickham Date: Fri, 5 Feb 2021 12:59:33 -0600 Subject: [PATCH 2/2] Update badges for latest lifecycle updates --- R/ci.R | 2 +- R/data-table.R | 2 -- R/github-labels.R | 2 +- R/github.R | 4 ++-- R/pkgdown.R | 2 +- R/release.R | 2 +- R/usethis-defunct.R | 2 +- man/ci.Rd | 2 +- man/create_from_github.Rd | 4 ++-- man/git_credentials.Rd | 2 +- man/use_data_table.Rd | 2 -- man/use_github.Rd | 2 +- man/use_github_labels.Rd | 2 +- man/use_github_links.Rd | 2 +- man/use_github_release.Rd | 2 +- man/use_pkgdown.Rd | 2 +- 16 files changed, 16 insertions(+), 20 deletions(-) diff --git a/R/ci.R b/R/ci.R index 956ff303a..365190155 100644 --- a/R/ci.R +++ b/R/ci.R @@ -2,7 +2,7 @@ #' #' @description #' -#' `r lifecycle::badge("soft-deprecated")` +#' `r lifecycle::badge("deprecated")` #' #' Some of these functions are now soft-deprecated since the tidyverse team has #' started using [GitHub Actions (GHA)](https://github.com/features/actions) for diff --git a/R/data-table.R b/R/data-table.R index 5615affae..5ebf67e37 100644 --- a/R/data-table.R +++ b/R/data-table.R @@ -2,8 +2,6 @@ #' #' @description #' -#' `r lifecycle::badge("questioning")` -#' #' `use_data_table` facilitates importing the data.table package by handling #' up-front some common set-up tasks for using it in your package. #' diff --git a/R/github-labels.R b/R/github-labels.R index fa92d6462..a6361bc18 100644 --- a/R/github-labels.R +++ b/R/github-labels.R @@ -22,7 +22,7 @@ #' * `good first issue` indicates a good issue for first-time contributors. #' * `help wanted` indicates that a maintainer wants help on an issue. #' -#' @param repo_spec,host,auth_token `r lifecycle::badge("defunct")`: These +#' @param repo_spec,host,auth_token `r lifecycle::badge("deprecated")`: These #' arguments are now deprecated and will be removed in the future. Any input #' provided via these arguments is not used. The target repo, host, and auth #' token are all now determined from the current project's Git remotes. diff --git a/R/github.R b/R/github.R index f90990bf5..312743cb4 100644 --- a/R/github.R +++ b/R/github.R @@ -34,7 +34,7 @@ #' For a hypothetical GitHub Enterprise instance, either #' "https://github.acme.com/api/v3" or "https://github.acme.com" is #' acceptable. -#' @param auth_token,credentials `r lifecycle::badge("defunct")`: No longer +#' @param auth_token,credentials `r lifecycle::badge("deprecated")`: No longer #' consulted now that usethis uses the gert package for Git operations, #' instead of git2r; gert relies on the credentials package for auth. The API #' requests are now authorized with the token associated with the `host`, as @@ -176,7 +176,7 @@ use_github <- function(organisation = NULL, #' an interactive session, the user can confirm which repo to use for the #' links. In a noninteractive session, links are formed using `upstream`. #' -#' @param host,auth_token `r lifecycle::badge("defunct")`: No longer consulted +#' @param host,auth_token `r lifecycle::badge("deprecated")`: No longer consulted #' now that usethis consults the current project's GitHub remotes to get the #' `host` and then relies on gh to discover an appropriate token. #' @param overwrite By default, `use_github_links()` will not overwrite existing diff --git a/R/pkgdown.R b/R/pkgdown.R index cdd905698..58abadcee 100644 --- a/R/pkgdown.R +++ b/R/pkgdown.R @@ -10,7 +10,7 @@ #' Learn more about [use_github_action()]. This approach is actively #' maintained, because it is in use across many tidyverse, r-lib, and #' tidymodels packages. -#' * `use_pkgdown_travis()` `r lifecycle::badge("soft-deprecated")` helps you +#' * `use_pkgdown_travis()` `r lifecycle::badge("deprecated")` helps you #' set up pkgdown for automatic deployment on Travis-CI. This is #' soft-deprecated, as the tidyverse team has shifted away from Travis-CI #' and towards GitHub Actions. `use_pkgdown_travis()` creates an empty diff --git a/R/release.R b/R/release.R index 0d2273c22..7710a8c58 100644 --- a/R/release.R +++ b/R/release.R @@ -131,7 +131,7 @@ release_type <- function(version) { #' need to publish the release from GitHub. It also deletes `CRAN-RELEASE` and #' checks that you've pushed all commits to GitHub. #' -#' @param host,auth_token `r lifecycle::badge("defunct")`: No longer consulted +#' @param host,auth_token `r lifecycle::badge("deprecated")`: No longer consulted #' now that usethis allows the gh package to lookup a token based on a URL #' determined from the current project's GitHub remotes. #' @export diff --git a/R/usethis-defunct.R b/R/usethis-defunct.R index ccae5c221..168d8c5bc 100644 --- a/R/usethis-defunct.R +++ b/R/usethis-defunct.R @@ -103,7 +103,7 @@ deprecate_warn_credentials <- function(whos_asking, details = NULL) { #' #' @description #' -#' `r lifecycle::badge("defunct")` +#' `r lifecycle::badge("deprecated")` #' #' In usethis v2.0.0, usethis switched from git2r to gert (+ credentials) for #' all Git operations. This pair of packages (gert + credentials) is designed to diff --git a/man/ci.Rd b/man/ci.Rd index 30731e877..b1d9712ff 100644 --- a/man/ci.Rd +++ b/man/ci.Rd @@ -42,7 +42,7 @@ of R, change the tag from \code{latest} to the version you want, e.g. \verb{rocker/r-ver:3.5.3}.} } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}} Some of these functions are now soft-deprecated since the tidyverse team has started using \href{https://github.com/features/actions}{GitHub Actions (GHA)} for diff --git a/man/create_from_github.Rd b/man/create_from_github.Rd index 6d0a2f85c..7bebc94d0 100644 --- a/man/create_from_github.Rd +++ b/man/create_from_github.Rd @@ -73,13 +73,13 @@ For a hypothetical GitHub Enterprise instance, either "https://github.acme.com/api/v3" or "https://github.acme.com" is acceptable.} -\item{auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +\item{auth_token}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: No longer consulted now that usethis uses the gert package for Git operations, instead of git2r; gert relies on the credentials package for auth. The API requests are now authorized with the token associated with the \code{host}, as retrieved by \code{\link[gh:gh_token]{gh::gh_token()}}.} -\item{credentials}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +\item{credentials}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: No longer consulted now that usethis uses the gert package for Git operations, instead of git2r; gert relies on the credentials package for auth. The API requests are now authorized with the token associated with the \code{host}, as diff --git a/man/git_credentials.Rd b/man/git_credentials.Rd index 0e0abca04..00cd43a39 100644 --- a/man/git_credentials.Rd +++ b/man/git_credentials.Rd @@ -20,7 +20,7 @@ use_git_credentials(credentials = deprecated()) These functions raise a warning and return an invisible \code{NULL}. } \description{ -\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}} +\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}} In usethis v2.0.0, usethis switched from git2r to gert (+ credentials) for all Git operations. This pair of packages (gert + credentials) is designed to diff --git a/man/use_data_table.Rd b/man/use_data_table.Rd index 1dab82928..19c8ed632 100644 --- a/man/use_data_table.Rd +++ b/man/use_data_table.Rd @@ -7,8 +7,6 @@ use_data_table() } \description{ -\ifelse{html}{\out{Questioning lifecycle}}{\strong{Questioning}} - \code{use_data_table} facilitates importing the data.table package by handling up-front some common set-up tasks for using it in your package. diff --git a/man/use_github.Rd b/man/use_github.Rd index de9573f28..fafbd893d 100644 --- a/man/use_github.Rd +++ b/man/use_github.Rd @@ -33,7 +33,7 @@ For a hypothetical GitHub Enterprise instance, either "https://github.acme.com/api/v3" or "https://github.acme.com" is acceptable.} -\item{auth_token, credentials}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer +\item{auth_token, credentials}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: No longer consulted now that usethis uses the gert package for Git operations, instead of git2r; gert relies on the credentials package for auth. The API requests are now authorized with the token associated with the \code{host}, as diff --git a/man/use_github_labels.Rd b/man/use_github_labels.Rd index 44d1a87ff..638ac4ea6 100644 --- a/man/use_github_labels.Rd +++ b/man/use_github_labels.Rd @@ -35,7 +35,7 @@ tidy_label_colours() tidy_label_descriptions() } \arguments{ -\item{repo_spec, host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: These +\item{repo_spec, host, auth_token}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: These arguments are now deprecated and will be removed in the future. Any input provided via these arguments is not used. The target repo, host, and auth token are all now determined from the current project's Git remotes.} diff --git a/man/use_github_links.Rd b/man/use_github_links.Rd index 0a89ea2bd..9e28ac577 100644 --- a/man/use_github_links.Rd +++ b/man/use_github_links.Rd @@ -11,7 +11,7 @@ use_github_links( ) } \arguments{ -\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer consulted +\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: No longer consulted now that usethis consults the current project's GitHub remotes to get the \code{host} and then relies on gh to discover an appropriate token.} diff --git a/man/use_github_release.Rd b/man/use_github_release.Rd index acb9fb280..76591de3d 100644 --- a/man/use_github_release.Rd +++ b/man/use_github_release.Rd @@ -7,7 +7,7 @@ use_github_release(host = deprecated(), auth_token = deprecated()) } \arguments{ -\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-defunct.svg}{options: alt='Defunct lifecycle'}}{\strong{Defunct}}: No longer consulted +\item{host, auth_token}{\ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}}: No longer consulted now that usethis allows the gh package to lookup a token based on a URL determined from the current project's GitHub remotes.} } diff --git a/man/use_pkgdown.Rd b/man/use_pkgdown.Rd index 12901e112..bf57d7a9f 100644 --- a/man/use_pkgdown.Rd +++ b/man/use_pkgdown.Rd @@ -26,7 +26,7 @@ build and deploy your pkgdown site whenever you push changes to GitHub. Learn more about \code{\link[=use_github_action]{use_github_action()}}. This approach is actively maintained, because it is in use across many tidyverse, r-lib, and tidymodels packages. -\item \code{use_pkgdown_travis()} \ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} helps you +\item \code{use_pkgdown_travis()} \ifelse{html}{\figure{lifecycle-deprecated.svg}{options: alt='Deprecated lifecycle'}}{\strong{Deprecated}} helps you set up pkgdown for automatic deployment on Travis-CI. This is soft-deprecated, as the tidyverse team has shifted away from Travis-CI and towards GitHub Actions. \code{use_pkgdown_travis()} creates an empty