Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release checklist for 0.1.0 #5

Closed
20 tasks done
colearendt opened this issue Jul 13, 2019 · 0 comments · Fixed by #7
Closed
20 tasks done

Release checklist for 0.1.0 #5

colearendt opened this issue Jul 13, 2019 · 0 comments · Fixed by #7

Comments

@colearendt
Copy link
Owner

colearendt commented Jul 13, 2019

  • Create branch labelled v[version]-rc, for example, v1.5.2-rc (the "rc" stands for "Release Candidate").
  • Change the DESCRIPTION and NEWS on this branch to change the version number to the desired version for CRAN, e.g. from 1.5.1.9008 to 1.5.2.
  • Commit and push to the RC branch.
  • Clean your package directory to remove any extraneous files, including ones that are git-ignored. (Warning, this will delete any unsaved buffers in RStudio! Also, be sure to close RStudio before taking this step!) git clean -xdf .
    • NOTE: git clean -xdn . provides a "dry-run" list of what will be done / removed
  • Build your package. I (jcheng) personally do it from the Mac command line like this:
  • PATH=$PATH:/Applications/RStudio.app/Contents/MacOS/pandoc R CMD build [pkgdir]
  • Do a sanity check by installing/testing the built package.
  • Perform revdep check using https://github.com/r-lib/revdepcheck, if this is not the initial CRAN release.
  • Run R CMD check --as-cran pkg_version.tar.gz both locally and on win-builder. You can also use https://r-hub.github.io/rhub/.
  • I (jcheng) don't know how much it matters but I have this file as my ~/.R/Makevars:
  • CFLAGS += -Wall -pipe -pedantic -std=gnu99 -g -O0
  • CXXFLAGS += -Wall -pipe -Wno-unused -pedantic -g -O0
  • CXX11FLAGS += -Wall -pipe -Wno-unused -pedantic -g -O0
  • Read every bullet point in the CRAN Policies document if this is the first release of the package. I usually print it out and check off the items one by one.
  • Submit to CRAN via their online form.
  • If there are R CMD check warnings that are unavoidable, make sure to explain them in the comments.
  • If rejected, make changes on the RC branch and bump the fourth (patch) version component, i.e. 1.5.2.1.
  • When accepted, tag the RC branch with a v1.5.2.1 tag (or whatever version you finally ended up getting accepted), and push the tag to origin.
  • Merge RC into master.
  • On master, change the package version to 1.5.2.9000.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant