Skip to content

CRAN submission: How To

Jump to bottom
vlucet edited this page May 27, 2021 · 2 revisions

This page contains the information required to release a new version of this R package to CRAN. Essentially the steps to follow are all described in details here: https://r-pkgs.org/release.html. Unless specified otherwise, perform the following steps on R-latest.

  1. Ensure all tests pass. Note however that tests wont be performed on CRAN.

  2. Ensure all CRAN checks pass

    a. Verify under the github action tab that the package builds correctly on all platforms

    b. Verify locally that the package builds on R-devel using the Rsyncrosim build instance (note that this instance will need to be updated regurlarly with the latest version of R-devel).

  3. Use usethis::use_release_issue("the.version.number") to create a GitHub issue with a more thorough checklist, and follow the checklist.

  4. Unless already done, make sure to increase the version number in the DESCRIPTION file.

  5. Use devtools::release() and follow instructions.

  6. Ensure the current package maintainer, listed in the DESCRIPTION file, approves the email sent to the email address specified in the DESCRIPTION file.

  7. Monitor any communications from CRAN.

After CRAN has accepted the realease :

  1. Close the release issue.
  2. Make a release on GitHub.
Clone this wiki locally