Skip to content

Instantly share code, notes, and snippets.

@nanxstats

nanxstats/release_checklist_nanxstats.md

Last active June 4, 2024 14:42
Show Gist options
  • Save nanxstats/5c38e0520befdb6c323dc880d38a008c to your computer and use it in GitHub Desktop.
Save nanxstats/5c38e0520befdb6c323dc880d38a008c to your computer and use it in GitHub Desktop.
Download ZIP
Nan's simple R package release checklist
Raw
release_checklist_nanxstats.md

First release

  • Proof read Title: and Description: and ensure they are informative
  • Check that all exported functions have @returns and @examples
  • Check that Authors@R: includes a copyright holder (role 'cph')
  • Review extrachecks
  • usethis::use_cran_comments() (optional)

Prepare for release

  • Check current CRAN check results
  • Check licensing of included files
  • Review pkgdown reference index for, e.g., missing topics
  • Bump version
  • Update cran-comments.md (optional)
  • Update NEWS.md
  • Review pkgdown website
  • urlchecker::url_check()
  • Check with local machine
  • Check with GitHub Actions
  • Check with win-builder

Submit to CRAN

  • Draft GitHub release
  • Submit to CRAN via web form
  • Approve emails

Wait for CRAN

  • Accepted 🎉
  • Post on r-packages mailing list
  • Tweet
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment