name: Release Prep template about: Use this template to start a checklist of actions required to create a new version release for CRAN title: "[RELEASE PREP]" labels: '' assignees: ''
Below are the steps used to prepare FSA
for submission to CRAN. The steps should generally be followed in order (i.e., don't move to the next step without success at the current step). It is common to have to repeat some previous steps if an error/warning occurs at a subsequent step (in my experience, this most often happens after checking on the development version of R when using R-winbuilder).
It is worth noting that this whole process can take 2-3 hours (or more depending on internet speed) with significant "waiting time" for checks and builds.
FSA
and FSAdata
depend on.dev
branch (at local repo)dev
have been appropriately merged to dev
via pull request.Version
field in DESCRIPTION (next number up without the .9000 on the end).Date
field in DESCRIPTION.Version
in top header of NEWS.md (next number up without the .9000 on the end).cran-comments-vX_X_X.md
file in cran-comments
folder. This will likely just be a copy of the same file from the previous version, but may include notes specific to inquiries from CRAN operators. [Note that this will be used in Section 5 below, so leave the file open).pkgdown::build_site()
in the console of RStudio.dev
branch (at local repo)dev
. At times I will get a note about a new author or not being able to verify current time.]dev
branch on GitHub.dev
branch (at remote GitHub repo)dev
branch (this should run automatically with the push to dev
, but will take some time to finish (possibly >20 mins)). If not successful then address issues and repeat as much above as necessary.dev
branch to the main
branch. Ask someone from the FSA team to review the request. [Ensure that all checks were successfully completed.]main
branch (at remote GitHub repo)dev
branch.main
branch (at local repo)main
branch and pull the updates to local main
branch so that the local and remote main
branches are the same.Choose File
and choose the source file (.tar.gz) created above. Copy the comments from the relevant cran-comments-vX_X_X.md
and paste into the optional comments
box. Press the Upload Package
button.Submit Package
button at the bottom.Upload the Package to CRAN
. You should get a confirmation e-mail almost immediately (no need to respond to this).main
branch (at remote GitHub repo)Tag
should relate to the version number and the Title
should state that the version number is being released to CRAN (see past examples). Make sure that the Target
is set to Main
. Add an optional Description
if desired. Drag and drop the source (.tar.gz) and binary (.zip) files created in the previous step on to the Attach binaries ...
box. Press Publish Release
.dev
branch (at remote GitHub repo)main
branch to the dev
branch. This is needed after merging dev
to main
above so that the two branches are synced.main
branch (OK to do this without getting approval from FSA team member). Note that the dev
branch will say it is "1 commit ahead of main
" after this step.dev
branch (at local repo)dev
branch and pull the updates to local dev
branch so that the local and remote dev
branches are the same.Version
field in DESCRIPTION by appending .9000 to the end.dev
branch. This is the start of the next version.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.