docs/tech/tn0022.txt

   1                         Making a new wxWidgets release
   2                         ==============================
   3
   4 Creating release files
   5 ----------------------
   6
   7 Currently our release system uses a Python 2.x script to generate releases.
   8 The script requires Unix utilities such as tar, zip and unix2dos and thus must
   9 be run either on Unix or using Cygwin on Windows. To generate a release, simply
  10 run the following command:
  11
  12 build/tools/create-archive.py --compression=all /path/to/output/dir
  13
  14 This will produce zip, gzip and bzip archives of the tree (without
  15 "compression" argument only .gz is made). Note that this commands produces huge
  16 amounts of output so redirecting it to a file is recommended.
  17
  18 To add a prefix to the release, such as RC1, the SVN revision, or a date, just
  19 pass --postfix="postfix" to the script. More info on the options and their
  20 possible values can be found by calling `create-archive.py --help`.
  21
  22 IMPORTANT NOTE: You *must* run this script from a clean source tree, that is,
  23           with no junk files in it or modifications. This is because the
  24           release should be a pristine copy of the tree as of the time of
  25           release. If you have legitimate modifications in the tree that need
  26           to be in the release, commit them first.
  27
  28
  29 Alternative non official release scripts
  30 ----------------------------------------
  31
  32 If you use git-svn, then you can use alternative script that avoids the
  33 problems such as using non-clean tree and also has better handling of the ends
  34 of lines conversions. To use it you need to run
  35
  36 - build/tools/svn-find-native-eols.pl
  37 - build/tools/git-make-release
  38 - build/tools/make-html-docs
  39
  40 (the last one can also be used without git).
  41
  42
  43 Uploading
  44 ---------
  45
  46 Upload the files to SourceForge (the simplest is to scp them to
  47 sfusername,wxwindows@frs.sf.net:/home/frs/project/w/wx/wxwindows/x.y.z) and to
  48 ftp.wxwidgets.org (ask Chris to do it).
  49
  50 Create http://docs.wxwidgets.org/x.y.z/ (ask Bryan to do it).
  51
  52
  53 Announcement
  54 ------------
  55
  56 Post announcement at least to wx-announce@googlegroups.com.
  57
  58 TODO: where else to announce it?
  59
  60 Update www.wxwidgets.org, usually a news item is enough but something more can
  61 be called for for major releases.
  62
  63 Post to wxBlog if necessary.
  64
  65
  66 Version updates
  67 ---------------
  68
  69 Trac: mark the milestone corresponding to the release as completed and add a
  70 new version for it to allow reporting bugs against it (ask Vadim or Robin to do
  71 it).
  72
  73 Run misc/scripts/inc_release to increment micro version, i.e. replace x.y.z
  74 with x.y.z+1 (minor or major versions updates require manual intervention).