R/pb_delete.R

Defines functions pb_delete

Documented in pb_delete

#' Delete an asset attached to a release
#'
#' @inheritParams pb_upload
#' @param file file(s) to be deleted from the release. If `NULL` (default
#' when argument is omitted), function will delete all attachments to the release.
#' delete
#' @return `TRUE` (invisibly) if a file is found and deleted.
#' Otherwise, returns `NULL` (invisibly) if no file matching the name was found.
#' @export
#' @examples
#' \dontrun{
#' readr::write_tsv(mtcars, "mtcars.tsv.gz")
#' ## Upload
#' pb_upload("mtcars.tsv.gz",
#'           repo = "cboettig/piggyback-tests",
#'           overwrite = TRUE)
#' pb_delete("mtcars.tsv.gz",
#'           repo = "cboettig/piggyback-tests",
#'           tag = "v0.0.1")
#' }
#'
pb_delete <- function(file = NULL,
                      repo = guess_repo(),
                      tag = "latest",
                      .token = gh::gh_token()) {
  df <- pb_info(repo, tag, .token)

  if (is.null(file)) ids <- df$id

  if(!is.null(file) && any(!file %in% df$file_name)){
    missing <- file[!file %in% df$file_name]
    file <- file[file != missing]
    cli::cli_warn("{.val {missing}} not found in {.val {tag}} release of {.val {repo}}")
  }

  if(!is.null(file)){
    ids <- df[df$file_name %in% file, "id"]
  }

  if (length(ids) < 1) {
    cli::cli_warn("No file deletions performed.")
    return(invisible(NULL))
  }

  lapply(ids, function(id) {
    ## If we find matching id, Delete file from release.
    gh::gh("DELETE /repos/:owner/:repo/releases/assets/:id",
           owner = df$owner[[1]],
           repo = df$repo[[1]],
           id = id,
           .token = .token
    )
  })

  try({memoise::forget(pb_info)})

  if(getOption("piggyback.verbose", default = TRUE)) cli::cli_alert_info("Deleted {.val {file}} from {.val {tag}} release on {.val {repo}}")

  return(invisible(TRUE))
}

Try the piggyback package in your browser

Any scripts or data that you put into this service are public.

piggyback documentation built on July 20, 2022, 1:10 a.m.