inst/templates/pre-commit.R

In GerkeLab/grkmisc: A package of miscellaneously helpful functions

#!/usr/bin/env Rscript

# License: CC0 (just be nice and point others to where you got this)
# Author: Robert M Flight <rflight79@gmail.com>, github.com/rmflight
#
# This is a pre-commit hook that checks that there are files to be committed, and if there are, increments the package version
# in the DESCRIPTION file.
#
# To install it, simply copy this into the ".git/hooks/pre-commit" file of your git repo, change /path/2/Rscript, and make it
# executable. Note that /path/2/Rscript is the same as your /path/2/R/bin/R, or may be in /usr/bin/Rscript depending on your
# installation. This has been tested on both Linux and Windows installations.
#
# In instances where you do NOT want the version incremented, add the environment variable doIncrement=FALSE to your git call.
# eg "doIncrement=FALSE git commit -m "commit message"".
# This is useful when you change the major version number for example.

ALLOWED_BRANCHES <- c("master", "dev")

doIncrement <- TRUE # default

# get the environment variable and modify if necessary
tmpEnv <- as.logical(Sys.getenv("doIncrement"))
if (!is.na(tmpEnv)){
  doIncrement <- tmpEnv
}

ok_branch <- system("git rev-parse --abbrev-ref HEAD", intern=TRUE) %in% ALLOWED_BRANCHES
if (!ok_branch) cat("** Skipping version bump while not in", paste(ALLOWED_BRANCHES, collapse = ", "), "\n")
doIncrement <- doIncrement && ok_branch

# check that there are files that will be committed, don't want to increment version if there won't be a commit
fileDiff <- system("git diff HEAD --name-only", intern=TRUE)

if (doIncrement && "DESCRIPTION" %in% fileDiff) {
  # Don't want to overwrite manual version bump
  desc_diff <- system("git diff HEAD DESCRIPTION", intern = TRUE)
  doIncrement <- !any(grepl("\\+Version", desc_diff))
  staged_files <- system("git diff HEAD --name-only --staged", intern = TRUE)
  desc_staged <- "DESCRIPTION" %in% staged_files
  if (!desc_staged) {
    if (doIncrement) cat("DESCRIPTION had additional changes that were committed.\n")
    else cat("DESCRIPTION contains manual version bump but was not staged, so it was not committed.\n")
  }
}

if ((length(fileDiff) > 0) && doIncrement){
  currDir <- getwd() # this should be the top level directory of the git repo
  currDCF <- read.dcf("DESCRIPTION")
  currVersion <- currDCF[1,"Version"]
  splitVersion <- strsplit(currVersion, ".", fixed=TRUE)[[1]]
  nVer <- length(splitVersion)
  currEndVersion <- as.integer(splitVersion[nVer])
  newEndVersion <- as.character(currEndVersion + 1)
  splitVersion[nVer] <- newEndVersion
  newVersion <- paste(splitVersion, collapse=".")
  currDCF[1,"Version"] <- newVersion
  if ("Date" %in% colnames(currDCF)) currDCF[1, "Date"] <- strftime(as.POSIXlt(Sys.Date()), "%Y-%m-%d")
  write.dcf(currDCF, "DESCRIPTION")
  if (requireNamespace("usethis", quietly = TRUE)) usethis::use_tidy_description()
  system("git add DESCRIPTION")
  cat("Incremented package version", currVersion, "-->", newVersion, "and added to commit!\n")
}