Download.Release.Main

Uploading a new release of the Matlab/Octave version of WavePacket

Preparation phase

• Set the new version number inside Matlab/Octave function +prt/init.m. According to the suggestions for semantic versioning, version numbers should be constructed as MAJOR.MINOR.PATCH, where the three numbers increment as follows:

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backwards compatible manner
  • PATCH version when you make backwards compatible bug fixes
  • Run all demo examples, ideally under Matlab and under Octave; if possible keeping an eye on the animations created "on the fly"
  • Upload all input/output of the demo examples to the SourceForge web space to be accessed by the Wiki pages (web.sourceforge.net, folder /home/project-web/wavepacket/htdocs/Demos)
  • Check/update the general README file in the Git master branch

Upload phase

• Use Git to tag this version, typically "VersionX.Y.Z" with the integer numbers X,Y,Z standing for MAJOR, MINOR, PATCH, see above. Note that, by default, the git push command doesn’t transfer tags to remote servers. Hence, you shouldn't forget to specify the --tags option with the "git push" command
• Prepare a short description file README.md (using restricted MarkDown syntax), the content of which will typically be identical to the announcement in the WavePacket blog. Don't forget to enter the recent Git hash value.
• Create a snapshot of the tagged Git branch from the SourceForge Git repository and rename the downloaded zip file to WavePacket-x.y.z.zip
• Upload the files README.md and WavePacket-x.y.z.zip to the Files Section at SourceForge; mark the latter as the default download for all operating systems

After the dust has settled

• Update release information on the Wiki pages of WavePacket at SourceForge, also in the metadata of the project
• Update release information on the Wiki pages of WavePacket / Matlab version at SourceForge , also in the metadata of the subproject
• Update information about newest release on personal web pages of the developer(s)
• Announce the new release via the WavePacket mailing list by sending an email to "wavepacket-user@lists.sourceforge.net". Typically, the content of this mail will be identical to the announcement in the WavePacket blog. Then go to the mailing list administration and arrange for the next digest to be sent "right now".
• Possibly announce the new release via the MDN mailing list ?
• Unset the new version number inside Matlab/Octave function +prt/init.m