Version 2 (modified by atorf, 5 years ago)

—

Checklist for NEW RELEASES

  1. Decide new version number. Name branches accordingly!
    • Use x.yy where x is major version and yy release. (I.e. after 1.00 follows 1.01, 1.02, and so on.)
    • Only increase major version after huge improvements or when losing backwards compatibility
  1. Prepare sourcecode (m-files) in modules-folder:
    • Create new branch for new release.
    • Delete unused files, delete obsolete directories etc.
    • (clean up temporary / working comments if necessary)
  1. Create new toolbox branch
    • Copy m-files from modules-branch to this branch, overwrite
    • Remove unused and old files (cleanup from toolbox trunk)
    • Run utility script "create_documentation" under Linux
      • Run wg_publish to generate and update html-helpfiles
      • Edit (or run script) to add header and modify stylesheets of html-helpfiles
      • Run script to remove |, %+ and first ; from m-files
      • (might become obsolete: Run m2html for new (clean) m-files, edit css and headers)
    • Move the new html files in /output/help/ in /doc/functions/help
    • Overwrite the old m-files with new one in /output/mfiles
    • Check FunctionsOverview and similar html files: Up2date? If not, re-publish from m-file sources
    • Check dynamic wiki-content (command layer etc): Up2date? If not, copy-paste (and edit css) from web.
    • Edit changelog (txt) and or version-history (release.html), add new release notes.
    • Update demos and/or examples if necessary!
    • Delete current Contents.m in toolbox root (of current branch), generate new one using MATLABs report generator.
    • Run utilities-script ChangeContentsMEntriesForHelpbrowser.m, it creates NewContents?.m (reads Contents.m)
    • Delete Contents.m, rename NewContents?.m to Contents.m (silly step, change the script above if you have time)
    • /!\ Edit Contents.m: Add correct header from trunk, INCREASE VERSION NUMBER, edit RELEASE DATE!!!
    • If new functions or m-files were added: Update info.xml and other .xml files!
    • Did the ini-files change? Check!
    • Update README, README.txt and AUTHORS (if necessary)
  1. Test new toolbox branch
  • Remove all other trunk / tag paths, add this new branch path ONLY to MATLAB.
  • Open help browser, inspect toolbox documentation tree
  • Check Release notes and version history
  • Execute MATLAB command: info = ver('RWTHMindstormsNXT')
  • Are the demos executable and run correctly?
  • If present: Use test-script that calls all / most functions
  • Check if ini-example-files are up2date.
  • Export SVN-branch-folder to temp, zip it, extract it again, repeat steps above.
  • Recompile existing stand-alone demos and examples with new toolbox version
  • Compile new stand-alone demos…
  1. Create tag from toolbox branch
  • Export to temp folder, compress (zip)
  • Compress compiled stand-alone-demos (zip)
  • Upload to website (toolbox, demos, stand-alone)
  • Add Version history to wiki
  • Update news ticker.
  1. Consider merging final toolbox branch changes back into trunk!
  • Keep all trunks up2date (should be anyway)
  • Close fixed bug tickets inside Trac
  • Open new "bug reports" forum thread / Trac tickets for current version.