release/release_functions.R

In bcgov/bcmapsdata: BC Spatial Data For Use In 'bcmaps' Package

#' Tag the repo with the package version:
#'
#' @param repo path to bcmapsdata repo. Default `"."`
#' @param version bcmapsdata package version. By default reads it from the DESCRIPTION file
#' 
#' @return the package version
tag_pkg_repo <- function(repo = ".", version = as.character(read.dcf(file.path(repo, "DESCRIPTION"), "Version"))) {
  stopifnot(requireNamespace("git2r"))
  stopifnot(nzchar(Sys.getenv("GITHUB_PAT")))
  
  bcmapsdata_repo <- git2r::repository(repo)
  status <- git2r::status(bcmapsdata_repo)
  
  if (!all(vapply(status, length, FUN.VALUE = integer(1)) == 0)) {
    stop("You have uncommitted changes. Please commit or stash before proceeding")
  }
  
  tagname <- paste0("bcmapsdata version ", version)
  
  if (version %in% names(git2r::tags(bcmapsdata_repo))) {
    message("version ", version, " has already been tagged")
    return(version)
  }
  git2r::tag(bcmapsdata_repo, version, tagname)
  
  version
}

push_repo_and_tags <- function(repo, version) {

  bcmapsdata_repo <- git2r::repository(repo)
  # Push repo
  git2r::push(bcmapsdata_repo, "origin", "refs/heads/master",
              credentials = git2r::cred_token())
  
  # Push tag
  git2r::push(bcmapsdata_repo, "origin", paste0("refs/tags/", version), 
             credentials = git2r::cred_token())
  
}


#' List releases on GitHub for bcmaps.rdata
#'
#' @return list of lists of information about the releases
list_releases <- function() {
  stopifnot(requireNamespace("gh"))
  rels <- gh::gh(
    "/repos/bcgov/bcmapsdata/releases"
  )
  rels
}

#' Create a release from the version tag
#'
#' @param version bcmapsdata package version. By default reads it from the DESCRIPTION file
#'
#' @return list of information about the release
#' @export
#'
#' @examples
create_release <- function(version = as.character(read.dcf("DESCRIPTION", "Version"))) {
  stopifnot(requireNamespace("gh"))
  
  tagname <- paste0("bcmapsdata version ", version)
  release <- gh::gh("POST /repos/bcgov/bcmapsdata/releases", 
                tag_name = version, 
                name = tagname)
  release
}

#' Upload attachments to the github release
#' 
#' For all rds files in release-data, which are too big to include in the package,
#' attach them to the release so can be downloaded by bcmaps individually.
#'
#' @param release_url the upload_url of the release - 
#'                    best obtained from the output of `release()`
#'
upload_release_attachments <- function(repo = ".", release_url) {
  stopifnot(requireNamespace("httr"))
  stopifnot(requireNamespace("devtools"))
  stopifnot(requireNamespace("gh"))
  
  release_files <- list.files(file.path(repo, "release/release-data")
                              , pattern = "\\.rds", full.names = TRUE)
  
  upload_url <- gsub("\\{[^\\}]+}", "", release_url)
  
  for (f in release_files) {
    message("uploading ", f)
    
    gh::gh(
      paste0("POST ", upload_url, "?name=", basename(f)), 
      readBin(f, raw(), file.info(f)$size),
      .send_headers = c("Content-Type" = "application/octet-stream")
    )
  }
  invisible(TRUE)
}

#' Add new bcmapsdata to drat
#'
#' @param drat_loc path to the drat repo (a local clone of https://github.com/bcgov/drat)
#' @param cleanup remove the built tar.gz file after it's been added to drat?
#'
add_to_drat <- function(drat_loc = "../drat", cleanup = TRUE) {
  stopifnot(requireNamespace("devtools"))
  stopifnot(requireNamespace("git2r"))
  stopifnot(requireNamespace("drat"))
  stopifnot(nzchar(Sys.getenv("GITHUB_PAT")))
  message("Building bcmapsdata...")
  built_bcmapsdata_file <- devtools::build()
  if (cleanup) {
    on.exit(unlink(built_bcmapsdata_file))
  }
  
  # Get current package version
  ver <- as.character(read.dcf("DESCRIPTION", "Version"))
  drat_loc <- normalizePath(drat_loc, winslash = "/", mustWork = TRUE)
  drat_repo <- git2r::repository(drat_loc)
  
  # Pull first
  git2r::pull(drat_repo)
  
  # Insert built package into the drat repo
  drat::insertPackage(built_bcmapsdata_file, drat_loc)
  
  # Add files, commit, and push to drat repo
  git2r::add(drat_repo, ".")
  git2r::commit(drat_repo, paste("Add bcmapsdata", ver))
  git2r::push(drat_repo, "origin", "refs/heads/gh-pages", 
              credentials = git2r::cred_token())
  
}

add_auth_header <- function() {
  pat <- Sys.getenv("GITHUB_PAT")
  if (nzchar(pat)) {
    return(httr::add_headers(Authentication = paste0("token ", pat)))
  }
  invisible(NULL)
}