Changes between Version 7 and Version 8 of DevelopmentProcessOutline


Ignore:
Timestamp:
06/07/13 12:35:11 (4 years ago)
Author:
skyebend
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DevelopmentProcessOutline

    v7 v8  
    33 
    44Obviously real life doesn't always work this way, but I think this is a good checklist.  A bunch of the suggestions I give are tool specific, but there should be equivalent commands for what ever development environment you use.  
     5 
     6Here are some windows-specific instructions: BuildingPackage 
    57 
    68== Tools and Setup == 
     
    6769 
    6870=== debug on error === 
    69 {{{options(error=utils::recover)}}}  This makes it so each time you hit an error, it will automatically drop into the debugger so you can peek at the state of all the variables.  
     71{{{options(error=recover)}}}  This makes it so each time you hit an error, it will automatically drop into the debugger so you can peek at the state of all the variables.  
    7072 
    7173=== convert warnings to errors for debugging === 
     
    9092 
    9193R includes a very sophisticated and helpful system to run a series of checks for package consistency and code problems such as mis-match between code and documentation. It also runs the suite of tests which will (hopefully) reveal if new changes have broken old tests or examples.  The checks can be run from the RStudio Project>Build tab,  or from the command line with {{{R CMD check}}}. Even when I make 'minor' changes, I almost always break something that the package check flags for me. One reason is that I often forget that I may have R objects or functions defined in my workspace that are not actually part of the package.  Running the checks makes sure all the tests are run against 'clean' package code. 
    92  
    93  
    9494 
    9595Since other developers will be running the package checks against their code, its important to make sure that the code you are committing doesn't break the checks (warnings are OK).   
     
    127127  * check for hidden files (or build from clean checkout) 
    128128 
    129   * build to tar.gz and run {{{R CMD check --as-cran}}} 
     129  * build to tar.gz and run {{{R CMD check --as-cran --timings}}} 
    130130 
    131   * verify passing checks on all three platforms 
     131  * verify passing checks on all three platforms (see NightlyBuildsPrivate) 
    132132 
    133   * move to preview release directory 
     133  * move to preview release directory (see StatnetRepository) 
    134134 
    135135  * announce release preview 
    136136 
    137   * check for reverse dependencies, email devs if necessary 
     137  * check for reverse dependencies if packages exists on cran, email devs if necessary 
    138138 
    139139  * go through CRAN checklist http://cran.r-project.org/web/packages/policies.html 
    140140 
    141   * upload to cran ftp  and email cran 
     141  * upload to check with CRAN's winbuilder service: http://win-builder.r-project.org/upload.aspx 
     142 
     143  * upload to cran via web submission form http://cran.r-project.org/submit.html 
    142144 
    143145