New release script docs.
[wxWidgets.git] / docs / tech / tn0022.txt
1                   Working with the the wxWidgets release system
2                     =====================================
3
4 Process Overview:
5 - run build/tools/create-archive.py --compression=all /path/to/output/dir
6 - upload release to sf.net
7 - update wxwidgets.org
8 - promote release on software download sites
9
10
11 Currently our release system uses a Python 2.x script to generate releases.  The script requires Unix utilities such as tar, zip and unix2dos and thus must be run either on Unix or using Cygwin on Windows. To generate a release, simply run the following command:
12
13 build/tools/create-archive.py --compression=all /path/to/output/dir
14
15 This will produce zip, gzip and bzip archives of the tree. 
16
17 To add a prefix to the release, such as RC1, the SVN revision, or a date, just pass --postfix="postfix" to the script. More info on the options and their possible values can be found by calling `create-archive.py --help`.
18
19 IMPORTANT NOTE: You *must* run this script from a clean source tree, that is, with no junk files in it or modifications. This is because the release should be a pristine copy of the tree as of the time of release. If you have legitimate modifications in the tree that need to be in the release, commit them first.
20