etc/CRAN_submission_checklist.md

In bertcarnell/lhs: Latin Hypercube Samples

CRAN Submission Checklist

Docker Prep

• [ ] Prepare docker images for docker checks
  • In the bertcarnell/lhs-debug repository
  • [ ] docker build -t wch1/r-devel --no-cache r-devel
  • [ ] docker build -t wch1/r-debug-1 r-debug-1
  • [ ] docker build -t wch1/r-debug-2 r-debug-2
  • [ ] docker build -t wch1/r-debug-3 r-debug-3
  • [ ] docker build -t wch1/r-debug-4 r-debug-4
  • [ ] docker build -t wch1/r-debug r-debug
  • [ ] docker build -t bertcarnell/lhs-debug lhs-debug
  • [ ] docker push bertcarnell/lhs-debug

Local Windows

• [ ] Run bclib tests in PowerShell
• cd ../bclib
• sh cmakeshell.sh Release
• [ ] Run oa tests in PowerShell
• ensure any recent changes to bclib are git pulled as a submodule in oa (git submodule update in git bash)
• cd ../oa/src
• sh cmakeshell.sh Release
• [ ] Run lhslib tests in PowerShell
• ensure any recent change to bclib are git pulled as a submodule in lhslib (git submodule update in git bash)
• cd ../lhslib/src
• sh cmakeshell.sh Release
• [ ] Increment lhs version up from CRAN if not already done
• [ ] Check the ChangeLog entry for the version to be released
• [ ] Copy the sub-project code in to src
• sh developmentBuild.sh
• [ ] Build the Visual Studio project in PowerShell (does not compile, but is useful for debugging and C++ development)
• sh cmakeshell.sh
• [ ] Doxygen deployment to docs in PowerShell (output directory specified in the Doxyfile)
• doxygen Doxyfile
• RStudio
• [ ] Document with roxygen2 by running Document in the UI
• [ ] Run testthat tests by running Test Package in the UI
• [ ] Build the .tar.gz or R CMD build lhs
• [ ] Run check or R CMD check --as-cran lhs_<version>.tar.gz
• [ ] In R, create the pkgdown site with pkgdown::build_site()
• [ ] commit and push all updates to github

Github Actions Checks

R CMD check on Mac, Windows, and Linux

• [ ] Check the results of the R-CMD-Check.yaml checks on all platforms

rhub checks

• [ ] Mannually trigger the rhub checks in Github actions rhub-checks.yml
• [ ] Check the results of rhub checks on email

Valgrind, gcc ASAN, and clang ASAN memory checks

• [ ] Check the results of docker-builds.yml

Other Checks

win-builder

• https://win-builder.r-project.org/upload.aspx
• [ ] upload the lhs_<version>.tar.gz from the step above

Appveyor

• check appveyor results once built
• [ ] https://ci.appveyor.com/project/bertcarnell/lhs/branch/master

Local Linux

• [ ] git pull
• [ ] Run bclib tests
• cd ../bclib
• sh cmakeshell.sh Release
• [ ] Run oa tests
• ensure any recent changes to bclib are git pulled
• cd ../oa
• git submodule update
• sh cmakeshell.sh Release
• [ ] Run lhslib tests
• ensure any recent change to bclib are git pulled
• cd ../lhslib
• git submodule update
• sh cmakeshell.sh Release
• [ ] sh developmentBuild.sh
• [ ] sh cmakeshell.sh
• [ ] R CMD build lhs
• [ ] R CMD check --as-cran --use-valgrind lhs_<version>.tar.gz

Reverse Dependencies

• [ ] Build the Docker image
• Notes
• [ ] Check the dependencies
• Notes
• upload the results
• copy to /etc and push

Submit to CRAN

• [ ] form
• [ ] Tag the github repository with the version

bertcarnell/lhs documentation built on July 4, 2024, 3:55 p.m.