Rename use_tidy_pkgdown() to use_pkgdown_github_pages() (#1350)

Author: hadley

NAMESPACE

@@ -151,6 +151,7 @@ export(use_package_doc)
 export(use_partial_warnings)
 export(use_pipe)
 export(use_pkgdown)
+export(use_pkgdown_github_pages)
 export(use_pkgdown_travis)
 export(use_proprietary_license)
 export(use_r)
@@ -179,7 +180,6 @@ export(use_tidy_github)
 export(use_tidy_github_actions)
 export(use_tidy_issue_template)
 export(use_tidy_labels)
-export(use_tidy_pkgdown)
 export(use_tidy_release_test_env)
 export(use_tidy_style)
 export(use_tidy_support)

NEWS.md

@@ -1,5 +1,9 @@
 # usethis (development version)
 
+* `use_tidy_pkgdown()` has been renamed to `use_pkgdown_github_pages()` since
+  the function is useful for anyone who wants to automatically publish to GitHub
+  pages, not just the tidyverse team (#1308).
+
 * All functions that require a package now ask you if you'd like to install it.
 
 `use_readme_rmd()`, `use_readme_md()`, `use_tidy_contributing()`, and `use_tidy_support()` use updated logic for determining the `OWNER/REPO` spec of the target repo (#1312).

R/github-pages.R

@@ -35,7 +35,7 @@
 #'
 
 #' @seealso
-#' * [use_tidy_pkgdown()] combines `use_github_pages()` with other functions to
+#' * [use_pkgdown_github_pages()] combines `use_github_pages()` with other functions to
 #' fully configure a pkgdown site
 #' * <https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages>
 #' * <https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#pages>

R/pkgdown.R

@@ -1,22 +1,26 @@
 #' Use pkgdown
 #'
+#' @description
 #' [pkgdown](https://pkgdown.r-lib.org) makes it easy to turn your package into
-#' a beautiful website. A couple functions help you begin to use pkgdown:
-#'   * `use_pkgdown()`: creates a pkgdown config file, adds relevant files or
-#'     directories to `.Rbuildignore` and `.gitignore`, and builds favicons if
-#'     your package has a logo.
-#'   * `use_github_action("pkgdown")` configures a GitHub Actions workflow to
-#'     build and deploy your pkgdown site whenever you push changes to GitHub.
-#'     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.
+#' a beautiful website. usethis provides two functions help you use pkgdown:
+#'
+#' * `use_pkgdown()`: creates a pkgdown config file, adds relevant files or
+#'   directories to `.Rbuildignore` and `.gitignore`, and builds favicons if
+#'   your package has a logo.
+#'
+#' * `use_pkgdown_github_pages()`: implements the GitHub setup needed to
+#'   automatically publish your pkgdown site to GitHub pages:
+#'
+#'   - [use_github_pages()] prepares to publish the pkgdown site from the
+#'     `github-pages` branch
+#'   - [`use_github_action("pkgdown")`][use_github_action()] configures a
+#'     GitHub Action to automatically build the pkgdown site and deploy it via
+#'     GitHub Pages
+#'   - The pkgdown site's URL is added to the pkgdown configuration file,
+#'     to the URL field of DESCRIPTION, and to the GitHub repo.
+#'
+#' `use_pkgdown_travis()` is deprecated; we no longer recommend that you use
+#' Travis-CI.
 #'
 #' @seealso <https://pkgdown.r-lib.org/articles/pkgdown.html#configuration>
 #' @param config_file Path to the pkgdown yaml config file
@@ -49,21 +53,9 @@ use_pkgdown <- function(config_file = "_pkgdown.yml", destdir = "docs") {
 
 # tidyverse pkgdown setup ------------------------------------------------------
 
-#' @details
-#' * `use_tidy_pkgdown()`: Implements the pkgdown setup used for most tidyverse
-#'   and r-lib packages:
-#'   - [use_pkgdown()] does basic local setup
-#'   - [use_github_pages()] prepares to publish the pkgdown site from the
-#'     `github-pages` branch
-#'   - [`use_github_action("pkgdown")`][use_github_action()] configures a
-#'     GitHub Action to automatically build the pkgdown site and deploy it via
-#'     GitHub Pages
-#'   - The pkgdown site's URL is added to the pkgdown configuration file,
-#'     to the URL field of DESCRIPTION, and to the GitHub repo.
-#'
-#' @rdname tidyverse
+#' @rdname use_pkgdown
 #' @export
-use_tidy_pkgdown <- function() {
+use_pkgdown_github_pages <- function() {
   tr <- target_repo(github_get = TRUE)
 
   use_pkgdown()