prepare_release.R

#!/usr/bin/env Rscript
# Release-preparation checks for rSHUD v2.5.0.
#
# This script intentionally does not install packages, create tags, push tags,
# or publish GitHub Releases. It prints the post-merge commands maintainers can
# run after review and merge.

target_version <- "2.5.0"
target_tag <- paste0("v", target_version)
required_imports <- c("terra", "sf")
required_files <- c(
  "DESCRIPTION",
  "NEWS.md",
  "README.md",
  "README_cn.md",
  "inst/MIGRATION_GUIDE.md",
  "vignettes/migration-guide.Rmd",
  "docs/release/RELEASE_NOTES_v2.5.0.md",
  "docs/release/GITHUB_RELEASE_TEMPLATE.md",
  "docs/release/CRAN_SUBMISSION_CHECKLIST.md",
  "docs/release/RELEASE_SUMMARY.md",
  "docs/release/cran-comments.md"
)

ok <- TRUE
failures <- character()

mark <- function(pass, message) {
  if (pass) {
    cat("[OK]   ", message, "\n", sep = "")
  } else {
    cat("[FAIL] ", message, "\n", sep = "")
  }
}

record_failure <- function(message) {
  failures <<- c(failures, message)
  ok <<- FALSE
}

run_quiet <- function(command, args) {
  result <- tryCatch(
    suppressWarnings(system2(command, args, stdout = TRUE, stderr = TRUE)),
    error = function(err) {
      structure(conditionMessage(err), status = 127L)
    }
  )
  status <- attr(result, "status")
  if (is.null(status)) {
    status <- 0L
  }
  list(status = status, output = result)
}

output_text <- function(result) {
  if (length(result$output) == 0L) {
    return("")
  }
  paste(result$output, collapse = "\n")
}

print_diagnostics <- function(result) {
  text <- output_text(result)
  if (nzchar(text)) {
    cat("       Diagnostics:\n")
    cat("       ", gsub("\n", "\n       ", text), "\n", sep = "")
  }
}

github_release_not_found <- function(result) {
  if (result$status == 0L) {
    return(FALSE)
  }
  output <- output_text(result)
  nzchar(output) && grepl(
    "release not found|no release found",
    output,
    ignore.case = TRUE
  )
}

cat("=== rSHUD v2.5.0 Release-Preparation Checks ===\n\n")

cat("1. Required files\n")
for (path in required_files) {
  exists <- file.exists(path)
  mark(exists, path)
  if (!exists) {
    record_failure(paste("Missing required file:", path))
  }
}
cat("\n")

cat("2. DESCRIPTION metadata\n")
if (file.exists("DESCRIPTION")) {
  desc <- read.dcf("DESCRIPTION")
  version <- unname(desc[1, "Version"])
  date <- unname(desc[1, "Date"])
  mark(identical(version, target_version), paste("Version:", version))
  if (!identical(version, target_version)) {
    record_failure(paste("DESCRIPTION Version must be", target_version))
  }
  mark(!is.na(date) && nzchar(date), paste("Date:", date))
  imports <- desc[1, "Imports"]
  for (pkg in required_imports) {
    present <- grepl(paste0("(^|,\\s*)", pkg, "(\\s*\\(|,|$)"), imports)
    mark(present, paste(pkg, "listed in Imports"))
    if (!present) {
      record_failure(paste(pkg, "must be listed in DESCRIPTION Imports"))
    }
  }
} else {
  record_failure("Cannot read DESCRIPTION")
}
cat("\n")

cat("3. Release text checks\n")
text_checks <- list(
  list(file = "NEWS.md", pattern = "# rSHUD 2.5.0", label = "NEWS has v2.5.0 section"),
  list(file = "NEWS.md", pattern = "team-review", label = "NEWS states v3.0.0 team-review gate"),
  list(file = "README.md", pattern = "2.5.0", label = "README references v2.5.0"),
  list(file = "README_cn.md", pattern = "2.5.0", label = "README_cn references v2.5.0"),
  list(file = "inst/MIGRATION_GUIDE.md", pattern = "team-review", label = "Migration guide states v3.0.0 gate"),
  list(file = "vignettes/migration-guide.Rmd", pattern = "team-review", label = "Vignette states v3.0.0 gate"),
  list(file = "docs/release/CRAN_SUBMISSION_CHECKLIST.md", pattern = "merged `master`", label = "Checklist uses post-merge master gate"),
  list(file = "docs/release/GITHUB_RELEASE_TEMPLATE.md", pattern = "unmerged PR branch", label = "GitHub release template forbids PR publication")
)
for (check in text_checks) {
  present <- file.exists(check$file) &&
    any(grepl(check$pattern, readLines(check$file, warn = FALSE), fixed = TRUE))
  mark(present, check$label)
  if (!present) {
    record_failure(paste("Missing release text:", check$label))
  }
}
cat("\n")

cat("4. Publication guard\n")
local_tag <- run_quiet("git", c("rev-parse", "-q", "--verify", paste0("refs/tags/", target_tag)))
no_local_tag <- local_tag$status != 0L
mark(no_local_tag, paste("No local", target_tag, "tag exists"))
if (!no_local_tag) {
  record_failure(paste("Local tag already exists:", target_tag))
}

remote_tag <- run_quiet("git", c("ls-remote", "--exit-code", "--tags", "origin", target_tag))
no_remote_tag <- remote_tag$status == 2L
mark(no_remote_tag, paste("No remote", target_tag, "tag detected on origin"))
if (remote_tag$status == 0L) {
  record_failure(paste("Remote tag already exists:", target_tag))
} else if (!no_remote_tag) {
  record_failure(paste(
    "Could not verify remote tag state for",
    target_tag,
    "with git ls-remote; status:",
    remote_tag$status
  ))
  print_diagnostics(remote_tag)
}

github_release <- run_quiet("gh", c("-R", "SHUD-System/rSHUD", "release", "view", target_tag))
no_github_release <- github_release_not_found(github_release)
mark(no_github_release, paste("No GitHub Release", target_tag, "detected"))
if (github_release$status == 0L) {
  record_failure(paste("GitHub Release already exists:", target_tag))
} else if (!no_github_release) {
  record_failure(paste(
    "Could not verify GitHub Release absence for",
    target_tag,
    "with gh release view; status:",
    github_release$status
  ))
  print_diagnostics(github_release)
}
cat("\n")

cat("5. Optional package availability check\n")
for (pkg in required_imports) {
  installed <- requireNamespace(pkg, quietly = TRUE)
  mark(installed, paste(pkg, "installed in this R library"))
  if (!installed) {
    cat("       Install manually if you plan to build/check in this environment: install.packages(\"",
        pkg, "\")\n", sep = "")
  }
}
cat("\n")

cat("=== Summary ===\n")
if (!ok) {
  cat("Release-preparation checks failed:\n")
  for (failure in failures) {
    cat(" - ", failure, "\n", sep = "")
  }
  quit(status = 1)
}

cat("Release-preparation checks passed for rSHUD ", target_version, ".\n\n", sep = "")
cat("This script did not create tags, push tags, publish a GitHub Release, or install packages.\n\n")

cat("Required evidence commands:\n")
cat("Rscript -e 'desc <- read.dcf(\"DESCRIPTION\"); stopifnot(desc[1,\"Version\"] == \"2.5.0\")'\n")
cat("R CMD build --no-build-vignettes --no-manual --md5 --resave-data .\n")
cat("R CMD check --no-manual --no-build-vignettes --no-tests rSHUD_2.5.0.tar.gz\n\n")

cat("Post-merge publication commands, to run only from merged master:\n")
post_merge_commands <- c(
  "set -euo pipefail",
  "tag=\"v2.5.0\"",
  "",
  "git checkout master",
  "git pull --ff-only origin master",
  "",
  "if git rev-parse -q --verify \"refs/tags/${tag}\" >/dev/null; then",
  "  echo \"Local tag ${tag} already exists\" >&2",
  "  exit 1",
  "fi",
  "",
  "if remote_tag_output=\"$(git ls-remote --exit-code --tags origin \"${tag}\" 2>&1)\"; then",
  "  echo \"Remote tag ${tag} already exists on origin\" >&2",
  "  printf \"%s\\n\" \"$remote_tag_output\" >&2",
  "  exit 1",
  "else",
  "  remote_tag_status=$?",
  "  if [ \"$remote_tag_status\" -ne 2 ]; then",
  "    printf \"%s\\n\" \"$remote_tag_output\" >&2",
  "    echo \"Could not verify remote tag absence for ${tag}; git ls-remote exited ${remote_tag_status}\" >&2",
  "    exit \"$remote_tag_status\"",
  "  fi",
  "fi",
  "",
  "if release_view_output=\"$(gh -R SHUD-System/rSHUD release view \"${tag}\" 2>&1)\"; then",
  "  echo \"GitHub Release ${tag} already exists\" >&2",
  "  printf \"%s\\n\" \"$release_view_output\" >&2",
  "  exit 1",
  "else",
  "  release_view_status=$?",
  "  if ! printf \"%s\\n\" \"$release_view_output\" | grep -Eiq \"release not found|no release found\"; then",
  "    printf \"%s\\n\" \"$release_view_output\" >&2",
  "    echo \"Could not verify GitHub Release absence for ${tag}; gh release view exited ${release_view_status}\" >&2",
  "    exit \"$release_view_status\"",
  "  fi",
  "fi",
  "",
  "Rscript prepare_release.R",
  "",
  "rm -f rSHUD_2.5.0.tar.gz",
  "build_log=\"$(mktemp)\"",
  "trap 'rm -f \"$build_log\"' EXIT",
  "R CMD build --no-build-vignettes --no-manual --md5 --resave-data . 2>&1 | tee \"$build_log\"",
  "tarball=\"$(grep -Eo 'rSHUD_[^[:space:]]+\\.tar\\.gz' \"$build_log\" | tail -n 1)\"",
  "if [ -z \"$tarball\" ] || [ ! -f \"$tarball\" ]; then",
  "  echo \"R CMD build did not report a tarball that exists\" >&2",
  "  exit 1",
  "fi",
  "",
  "R CMD check --no-manual --no-build-vignettes --no-tests \"$tarball\"",
  "dirty_status=\"$(git status --porcelain)\"",
  "if [ -n \"$dirty_status\" ]; then",
  "  printf \"%s\\n\" \"$dirty_status\" >&2",
  "  echo \"Working tree has uncommitted changes after build/check; aborting before tag\" >&2",
  "  exit 1",
  "fi",
  "git tag -a \"${tag}\" -m \"rSHUD v2.5.0\"",
  "git push origin \"${tag}\"",
  "git ls-remote --exit-code --tags origin \"${tag}\" >/dev/null",
  "gh release create v2.5.0 \"$tarball\" --verify-tag --title \"rSHUD v2.5.0\" --notes-file docs/release/GITHUB_RELEASE_TEMPLATE.md"
)
cat(paste(post_merge_commands, collapse = "\n"), "\n", sep = "")