How to package and upload a release

Package the release

(Detailed instructions on Sourceforge documentation)

Checklist

First, verify that the SVN version works and is ready for release. Before releasing a version of the mwetoolkit, you should verify the following:

• The copyright statements of ALL scripts and programs are up-to-date (date) and contain all the names of developers of the toolkit up to now
• All command-line options used in the scripts have a corresponding "usage" description
• The scripts read and generate all kinds of unicode data, no char encoding problem
• The scripts have proper error messages
• Every function in every script has a docstring. The docstring describes the function behaviour, the input parameters (@param) and the output (@return)
• The VERSIONS and README files are up-to-date
• All TABs are replaced by 4 spaces.
• Finally, the most important, all scripts were tested in several configurations

Prepare the release

• Then, go to a folder where you want to create the release and checkout a fresh new copy of the svn

svn checkout svn://svn.code.sf.net/p/mwetoolkit/code/ mwetoolkit

• Rename this folder to contain the new version number, like

mv mwetoolkit mwetoolkit_XX

• Now, navigate through the folder structure and make sure you updated everything such as:

  • Version number
  • README and VERSIONS file
  • Test files, remove obsolete and temporary files
    • find -name old, then remove
    • remove doc folder

• IMPORTANT: remove ALL .svn folders, as this is not necessary for a release and can make the final release file very fat ;-)

for f in $(ls -aR mwetoolkit_XX/ | grep '/.svn:' | sed 's/://g'); do rm -rf $f; done

• Once you're ready, package the folder using zip

zip -r mwetoolkit_XX.zip mwetoolkit_XX

Upload the release

In order to upload the release, you must put it at the home folder of the file server:

scp mwetoolkit_XX.zip username,mwetoolkit@frs.sourceforge.net:/home/frs/project/m/mw/mwetoolkit/

You are almost ready!

Open sourceforge files page and configure the new .zip as the default download file for all operating systems. Also move the previous release to old folder.

Be a little patient because the release sometimes takes some time to show up at the project page. But after some minutes, it will be there :-)