Create an appropriately named issue (e.g., "Release package version version.").
Copy-paste this file into the issue text to provide the checklist functionality.
After a commit directly pursuant to a checkbox item, uncheck all checkboxes below it.
After any other commit to master branch, uncheck all boxes from the "master branch" section down.
After any other commit to *release* branch, uncheck boxes from the "Release branch" section down.
Close the issue after all boxes are checked.
master branch
[x] DESCRIPTION: Package's CRAN dependencies require a recent CRAN version.
[x] DESCRIPTION: Package's dependencies that are a part of R core (base, datasets, grDevices, methods, splines, stats4, tools, utils, compiler, graphics, grid, parallel, stats, tcltk, translations) do not specify a version.
[x] DESCRIPTION: Package's dependencies that are usually shipped with R (KernSmooth, Matrix, MASS, class, nnet, spatial, boot, cluster, codetools, foreign, lattice, mgcv, nlme, rpart, survival) do not specify a version unless necessary.
[x] All tickets associated with the release's milestone have been resolved.
[x] The stubs file in inst/include/ is up to date if needed.
[x] Roxygen has been run on the package since last commit to code, documentation, or DESCRIPTION.
[x] Relevant tutorials run satisfactorily.
[x] inst/NEWS.Rd: file is up to date: none of the commits since the last commit to explicitly mention updating the NEWS file are newsworthy.
[x] LICENSE: license refers to the correct package.
[x] LICENSE: affiliations are up to date.
[x] LICENSE: copyright year range is correct.
[x] All files that should have copyright headers have them. Generally, it never hurts to rerun addcopyheaders to ensure this.
[x] All GitHub Action R-CMD-check.yaml tests pass.
Release branch
[x] Release branch has had the latest master merged into it. (git checkout *release*; git merge master)
[x] DESCRIPTION: There are no Remotes: directives (unless releasing simultaneously).
[x] DESCRIPTION: Release branch's version number does not have commit number attached to it.
[x] DESCRIPTION: Date is today.
[x] CITATION: update_CITATION has been run after installing all the mentioned packages from the release branch.
[x] All files in the release branch have been committed and pushed to GitHub.
[x] R-CMD-check.yaml: Flag strict is set for all jobs, and they pass.
[x] R-CMD-check.yaml: Flag vignettes is set for all jobs, and they pass. (Note: sometimes Windows LaTeX seems to fail.)
[x] R-CMD-check.yaml: Flag remote is set for at least some jobs, and they pass.
Checklist before submitting to CRAN
Directions for use
master
branch, uncheck all boxes from the "master
branch" section down.*release*
branch, uncheck boxes from the "Release branch" section down.master
branchDESCRIPTION
: Package's CRAN dependencies require a recent CRAN version.DESCRIPTION
: Package's dependencies that are a part of R core (base
,datasets
,grDevices
,methods
,splines
,stats4
,tools
,utils
,compiler
,graphics
,grid
,parallel
,stats
,tcltk
,translations
) do not specify a version.DESCRIPTION
: Package's dependencies that are usually shipped with R (KernSmooth
,Matrix
,MASS
,class
,nnet
,spatial
,boot
,cluster
,codetools
,foreign
,lattice
,mgcv
,nlme
,rpart
,survival
) do not specify a version unless necessary.inst/include/
is up to date if needed.DESCRIPTION
.inst/NEWS.Rd
: file is up to date: none of the commits since the last commit to explicitly mention updating theNEWS
file are newsworthy.LICENSE
: license refers to the correct package.LICENSE
: affiliations are up to date.LICENSE
: copyright year range is correct.addcopyheaders
to ensure this.R-CMD-check.yaml
tests pass.Release branch
master
merged into it. (git checkout *release*; git merge master
)DESCRIPTION
: There are noRemotes:
directives (unless releasing simultaneously).DESCRIPTION
: Release branch's version number does not have commit number attached to it.DESCRIPTION
: Date is today.CITATION
:update_CITATION
has been run after installing all the mentioned packages from the release branch.R-CMD-check.yaml
: Flagstrict
is set for all jobs, and they pass.R-CMD-check.yaml
: Flagvignettes
is set for all jobs, and they pass. (Note: sometimes Windows LaTeX seems to fail.)R-CMD-check.yaml
: Flagremote
is set for at least some jobs, and they pass.*pkg*.tar.gz
: the candidate submission file is from the latest version of the release branch.*pkg*.tar.gz
:R CMD check
passes withENABLE_statnet_TESTS=yes
environment variable and--run-donttest
.*pkg*.tar.gz
:R CMD check
passes with--as-cran
option withoutWARNING
s.*pkg*.tar.gz
:R CMD check
passes with--use-valgrind
option without memory errors.*pkg*.tar.gz
:rchk
static code analysis passes.*pkg*.tar.gz
:R CMD check
passes on the previous stable release (unless there is a good reason to require the latest R).*pkg*.tar.gz
:R CMD check
passes Win-Builder (https://win-builder.r-project.org).After release