R/check.R

In r-hub/rhub: Tools for R Package Developers

#' Check a package on R-hub
#'
#' @param gh_url GitHub URL of a package to check, or `NULL` to check
#'   the package in the current directory.
#' @param platforms Platforms to use, a character vector. Use `NULL` to
#'   select from a list in interactive sessions. See [rhub_platforms()].
#' @param r_versions Which R version(s) to use for the platforms that
#'   supports multiple R versions. This arguemnt is not implemented yet.
#' @param branch Branch to use to run R-hub. Defaults to the current
#'   branch if `gh_url` is `NULL`. Otherwise defaults to `"main"`. Note that
#'   this branch also need to include the `rhub.yaml` workflow file.
#' @return TODO
#'
#' @export

rhub_check <- function(gh_url = NULL, platforms = NULL, r_versions = NULL,
                       branch = NULL) {
  assert_that(
    is_optional_gh_url(gh_url),
    is_optional_character(platforms),
    is_optional_string(branch)
  )

  git_root <- if (is.null(gh_url)) setup_find_git_root()
  gh_url <- gh_url %||% doctor_find_gh_url(repo = git_root)
  pat <- doctor_find_pat(gh_url)

  if (is.null(branch)) {
    if (!is.null(git_root)) {
      branch <- gert::git_branch(repo = git_root)
    } else {
      branch <- "main"
    }
  }

  platforms <- select_platforms(platforms)

  url <- parse_gh_url(gh_url)
  ep <- glue::glue("/repos/{url$user}/{url$repo}/actions/workflows/rhub.yaml/dispatches")
  config <- list(platforms = platforms)
  name <- paste(platforms, collapse = ", ")
  id <- random_id()
  data <- list(
    ref = branch,
    inputs = list(
      config = jsonlite::toJSON(config, auto_unbox = TRUE),
      name = name,
      id = id
    )
  )
  jsondata <- jsonlite::toJSON(data, auto_unbox = TRUE)

  resp <- gh_rest_post(url$api, ep, token = pat, data = jsondata)

  if (resp$status_code != 204) {
    throw(pkg_error(
      ":( Failed to start check: {resp$content$message}.",
      i = "If you think this is a bug in the {.pkg rhub} package, please
           open an issues at {.url https://github.com/r-hub/rhub/issues}."
    ))
  }

  aurl <- paste0("https://", url$host, "/", url$user, "/", url$repo, "/actions")
  cli::cli_text()
  cli::cli_bullets(c(
    "v" = "Check started: {name} ({id}).",
    " " = "See {.url {aurl}} for live output!"
  ))


  invisible(NULL)
}