R/update_news.R

In PetterHopp/NVIpackager: Tools to facilitate Development of NVIverse Packages

#' @title Update "NEWS.md"
#' @description Create or update the "NEWS.md" file. It will include a template
#'    for new sections if relevant, and update the version number.
#'
#' @details Default is \code{template = NULL} that will only update the version number.
#'     Use \code{template = "first"} to make the "NEWS.md" template for the first
#'     release of the package. Use \code{template = "develop"} to make the "NEWS.md"
#'     template for the successive releases of the package.
#'
#' @template pkg
#' @template pkg_path
#' @param template [\code{character(1)}]\cr
#' The template to add to the "NEWS.md" file. Must be one of
#'     c("first", "develop"). Defaults to \code{NULL}.
#'
#' @return None. Creates or updates the "NEWS.md" file in the package directory.
#'
#' @author Petter Hopp Petter.Hopp@@vetinst.no
#' @export
#' @examples
#' \dontrun{
#' # Create the first "NEWS.md" file
#' library(NVIpackager)
#' update_news(template = "first")
#' }
update_news <- function(pkg = stringi::stri_extract_last_words(usethis::proj_path()),
                        pkg_path = usethis::proj_path(),
                        template = NULL) {

  # ARGUMENT CHECKING ----
  # Object to store check-results
  checks <- checkmate::makeAssertCollection()
  # assertions
  checks <- assert_pkg_path(pkg = pkg, pkg_path = pkg_path, add = checks)
  checkmate::assert_choice(template, choices = c("first", "develop"), null.ok = TRUE, add = checks)
  # Report check-results
  checkmate::reportAssertions(checks)

  # RUN SCRIPT ----

  # Fetch version and date from DESCRIPTION and generate header
  header <- paste("#",
                  desc::desc_get_field(key = "Package"),
                  desc::desc_get_field(key = "Version"),
                  paste0("- (", desc::desc_get_field(key = "Date"), ")"))

  # If NEWS exist read in file
  NEWS_file <- NULL
  if (file.exists(file.path(pkg_path, "NEWS"))) {NEWS_file <- "NEWS"}
  if (file.exists(file.path(pkg_path, "NEWS.md"))) {NEWS_file <- "NEWS.md"}

  if (!is.null(NEWS_file)) {
    history <- readLines(con = file.path(pkg_path, NEWS_file))
  } else {
    history <- ""
  }

  # If template = "first", then make first template for NEWS in a package. This
  #    is only relevant when the file NEWS doesn't exist.
  if (!is.null(template) && template == "first") {
    if (is.null(NEWS_file)) {
      template_text <- c("",
                         "## First release:",
                         "",
                         paste0(desc::desc_get_field(key = "Title"), ":"),
                         "",
                         "- `function1` description")
    }
  }

  # If template = "develop" update with development version number and include
  #     headlines for potential changes.
  if (!is.null(template) && template == "develop") {
    template_text <- c("",
                       "## New features:",
                       "",
                       "-",
                       "",
                       "",
                       "## Bug fixes:",
                       "",
                       "-",
                       "",
                       "",
                       "## Other changes:",
                       "",
                       "-",
                       "",
                       "",
                       "## BREAKING CHANGES:",
                       "",
                       "-",
                       "",
                       "")
  }

  # WRITE THE NEWS FILE ----
  if (is.null(NEWS_file)) {NEWS_file <- "NEWS.md"}
  if (is.null(template)) {
    history <- history[2:length(history)]
    writeLines(text = c(header, history),
               con = file.path(pkg_path, NEWS_file))
  } else {
    writeLines(text = c(header, template_text, history),
               con = file.path(pkg_path, NEWS_file))
  }
}