diff --git a/etc/CRAN_submission_checklist.md b/etc/CRAN_submission_checklist.md index 3075406..7a31f6c 100644 --- a/etc/CRAN_submission_checklist.md +++ b/etc/CRAN_submission_checklist.md @@ -3,38 +3,48 @@ ## Local Windows - [ ] Run `bclib` tests + - `cd ../bclib` - `sh cmakeshell.sh Release` - [ ] Run `oa` tests - - ensure any recent changes to `bclib` are `git pull`ed - - `sh cmakeshe1l.sh Release` + - ensure any recent changes to `bclib` are `git pull`ed as a submodule in `oa` + - `cd ../oa` + - `git submodule update` + - `sh cmakeshell.sh Release` - [ ] Run `lhslib` tests - - ensure any recent change to `bclib` are `git pull`ed + - ensure any recent change to `bclib` are `git pull`ed as a submodule in `lhslib` + - `cd ../lhslib` + - `git submodule update` - `sh cmakeshell.sh Release` -- [ ] Increment `lhs` version up from CRAN -- [ ] Check the `ChangeLog` entry -- [ ] `sh developmentBuild.sh` -- [ ] `sh cmakeshell.sh` to build Visual Studio project (does not compile) -- [ ] Doxygen +- [ ] 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 (does not compile, but is useful for debugging and C++ development) + - `sh cmakeshell.sh` +- [ ] Doxygen deployment to `docs` (output directory specified in the `Doxyfile`) + - `doxygen Doxyfile` - RStudio - - [ ] Document with `roxygen2` - - [ ] Run `testthat` tests - - [ ] `R CMD build` - - [ ] `R CMD check --as-cran` - - [ ] `pkgdown::build_site()` -- [ ] push all updates to `github` + - [ ] Document with `roxygen2` by running `Document` in the UI + - [ ] Run `testthat` tests by running `Test` in the UI + - [ ] Build the `.tar.gz` or `R CMD build` + - [ ] Run `check` or `R CMD check --as-cran` + - [ ] In R, create the `pkgdown` site with `pkgdown::build_site()` +- [ ] `commit` and `push` all updates to `github` #### rhub - from R or RStudio - - [ ] rhub::check_for_cran(path="path-to-package.tar.gz") - - [ ] rhub::check_with_valgrind(path="path-to-package.tar.gz") - - [ ] rhub::check_with_sanitizers(path="path-to-package.tar.gz") + - [ ] `rhub::check_for_cran(path="path-to-package/lhs-.tar.gz")` + - [ ] `rhub::check_with_valgrind(path="path-to-package/lhs-.tar.gz")` + - [ ] `rhub::check_with_sanitizers(path="path-to-package/lhs-.tar.gz")` #### win-builder + - https://win-builder.r-project.org/upload.aspx -- [ ] upload the .tar.gz +- [ ] upload the `lhs-.tar.gz` from the step above ## Travis and Appveyor + - check travis and appveyor results once built - [ ] https://travis-ci.org/bertcarnell/lhs - [ ] https://ci.appveyor.com/project/bertcarnell/lhs/branch/master @@ -43,14 +53,20 @@ - [ ] `git pull` - [ ] Run `bclib` tests + - `cd ../bclib` - `sh cmakeshell.sh Release` - [ ] Run `oa` tests - ensure any recent changes to `bclib` are `git pull`ed - - `sh cmakeshe1l.sh Release` + - `cd ../oa` + - `git submodule update` + - `sh cmakeshell.sh Release` - [ ] Run `lhslib` tests - ensure any recent change to `bclib` are `git pull`ed + - `cd ../lhslib` + - `git submodule update` - `sh cmakeshell.sh Release` -- [ ] `sh cmakeshell.sh` to build Visual Studio project (does not compile) +- [ ] `sh developmentBuild.sh` +- [ ] `sh cmakeshell.sh` - [ ] `R CMD build lhs` - [ ] `R CMD check --as-cran --use-valgrind`