release_procedure.R

# _____________________________________________________________________________________________________________________________________
# Release Procedure #####
# _____________________________________________________________________________________________________________________________________

# - Process to follow for creating a new CRAN release

# _____________________________________________________________________________________________________________________________________
# Import Packages #####
# _____________________________________________________________________________________________________________________________________

library(dplyr)

# _____________________________________________________________________________________________________________________________________
# 1) Manual File Updates #####
# _____________________________________________________________________________________________________________________________________

# Update DESCRIPTION
# - Package version
# - Package dependencies (cross-check with NAMESPACE - note that ggrepel is called in R/functioncollection_internal.R but doesn't show up in NAMESPACE)
# - Read through all sections and check validity

# Update NEWS.md
# - Remove development version tag (.9000) from header
# - Change "*development version*" to e.g. "*Enhancements and bug fixes*"

# Run update code at bottom of VariableLookup.R

# _____________________________________________________________________________________________________________________________________
# 2) Check Example Execution Time #####
# _____________________________________________________________________________________________________________________________________

# Run devtools check and save results to a temporary directory
# - If there is an error with running e.g. the PlotBasinSummary example, then try rerunning the check (some errors are intermittent)
check_dir <- tempdir()
devtools::check(incoming = T, args = "--timings", check_dir = check_dir)
timing_df <- read.delim(file.path(check_dir,"HYPEtools.Rcheck", "HYPEtools-Ex.timings")) %>%
  mutate(cpu = user + system) %>% # Calculate CPU time (user + system)
  arrange(desc(cpu))

# Check results
any(timing_df$cpu > 5) # Check if any CPU times > 5s
any(timing_df$elapsed > 5) # Check if any elapsed times >5s

# Cleanup
rm(timing_df)
unlink(check_dir)

# _____________________________________________________________________________________________________________________________________
# 3) Check Formatting #####
# _____________________________________________________________________________________________________________________________________

# check for T/F instead of TRUE/FALSE
lintr::lint_package(linters=list(lintr::T_and_F_symbol_linter()))

# spelling errors - Note that this function does not support having multiple languages in the DESCRIPTION file
devtools::spell_check()

# _____________________________________________________________________________________________________________________________________
# 4) Test Package #####
# _____________________________________________________________________________________________________________________________________

# Specify email to receive the results from the various checks
email <- "hypetools.rene@smhi.se"

# check and build package
devtools::check_win_release(email = email)
devtools::check_win_devel(email = email)
devtools::check_mac_release()
devtools::check_built(path = ".")

# If there is an error with running e.g. the PlotBasinSummary example, then try rerunning the check (some errors are intermittent)
# If there is an error Rd warning missing file link when linking to an alias, then switch from using \code{\link{<function>}} to using [package::function] format

# _____________________________________________________________________________________________________________________________________
# 5) Create Release & Update Repo #####
# _____________________________________________________________________________________________________________________________________

# Add release comments to cran-comments.md

# Commit any changes to GitHub

# Submit to CRAN, includes checks
devtools::release()

# AFTER CRAN APPROVAL --------------------------------------------------------------------------------------------------------------------

# Create version tag in GitHub repo
usethis::use_github_release()

# Add Date & Zenodo badge to GitHub Release

# After successful release
# - Update version number in DESCRIPTION to *.9000
# - Add date to release heading in NEWS.md:
#     ## HYPEtools 1.2.0 (2023-02-10)
# - Add development version heading to NEWS.md:
#     ## HYPEtools 1.5.0.9000
#     *Development Version*
#
#     #### Highlights