| 55 | | = Checklist for NEW RELEASES = |
| 56 | | This todo-list might have to be updated for future public releases with many developers / contributors collaborating, it was first intended for internal use and then published. |
| 57 | | |
| 58 | | 1. Decide new version number. Name branches accordingly! |
| 59 | | * Use x.yy where x is major version and yy release. (I.e. after 1.00 follows 1.01, 1.02, and so on.) |
| 60 | | * Only increase major version after huge improvements or when losing backwards compatibility |
| 61 | | |
| 62 | | 2. Prepare sourcecode (m-files) in modules-folder: |
| 63 | | * Create new branch for new release. |
| 64 | | * Delete unused files, delete obsolete directories etc. |
| 65 | | * (clean up temporary / working comments if necessary) |
| 66 | | |
| 67 | | 3. Create new toolbox branch |
| 68 | | * Copy m-files from modules-branch to this branch, overwrite |
| 69 | | * Remove unused and old files (cleanup from toolbox trunk) |
| 70 | | * Run utility script "create_documentation" under Linux |
| 71 | | * Run wg_publish to generate and update html-helpfiles |
| 72 | | * Edit (or run script) to add header and modify stylesheets of html-helpfiles |
| 73 | | * Run script to remove |, %+ and first ; from m-files |
| 74 | | * (might become obsolete: Run m2html for new (clean) m-files, edit css and headers) |
| 75 | | * Move the new html files in /output/help/ in /doc/functions/help |
| 76 | | * Overwrite the old m-files with new one in /output/mfiles |
| 77 | | * Check FunctionsOverview and similar html files: Up2date? If not, re-publish from m-file sources |
| 78 | | * Check dynamic wiki-content (command layer etc): Up2date? If not, copy-paste (and edit css) from web. |
| 79 | | * Edit changelog (txt) and or version-history (release.html), add new release notes. |
| 80 | | * Update demos and/or examples if necessary! |
| 81 | | * Delete current Contents.m in toolbox root (of current branch), generate new one using MATLABs report generator. |
| 82 | | * Run utilities-script !ChangeContentsMEntriesForHelpbrowser.m, it creates !NewContents.m (reads Contents.m) |
| 83 | | * Delete Contents.m, rename !NewContents.m to Contents.m (silly step, change the script above if you have time) |
| 84 | | * /!\ Edit Contents.m: Add correct header from trunk, INCREASE VERSION NUMBER, edit RELEASE DATE!!! |
| 85 | | * If new functions or m-files were added: Update info.xml and other .xml files! |
| 86 | | * Did the ini-files change? Check! |
| 87 | | * Update README, README.txt and AUTHORS (if necessary) |
| 88 | | |
| 89 | | |
| 90 | | 4. Test new toolbox branch |
| 91 | | * Remove all other trunk / tag paths, add this new branch path ONLY to MATLAB. |
| 92 | | * Open help browser, inspect toolbox documentation tree |
| 93 | | * Check Release notes and version history |
| 94 | | * Execute MATLAB command: `info = ver('RWTHMindstormsNXT')` |
| 95 | | * Are the demos executable and run correctly? |
| 96 | | * If present: Use test-script that calls all / most functions |
| 97 | | * Check if ini-example-files are up2date. |
| 98 | | * Export SVN-branch-folder to temp, zip it, extract it again, repeat steps above. |
| 99 | | * Recompile existing stand-alone demos and examples with new toolbox version |
| 100 | | * Compile new stand-alone demos... |
| 101 | | |
| 102 | | |
| 103 | | 5. Create tag from toolbox branch |
| 104 | | * Export to temp folder, compress (zip) |
| 105 | | * Compress compiled stand-alone-demos (zip) |
| 106 | | * Upload to website (toolbox, demos, stand-alone) |
| 107 | | * Add Version history to wiki |
| 108 | | * Update news ticker. |
| 109 | | |
| 110 | | |
| 111 | | 6. Consider merging final toolbox branch changes back into trunk! |
| 112 | | * Keep all trunks up2date (should be anyway) |
| 113 | | * Close fixed bug tickets inside Trac |
| 114 | | * Open new "bug reports" forum thread / Trac tickets for current version. |
| | 55 | |
| | 56 | = Checklist for New Releases = |
| | 57 | This todo-list might have to be updated for future public releases with many developers / contributors collaborating, it was first intended for internal use and then published -> '''[wiki:ReleaseCheckList Checklist for New Releases]'''. |