docs/tech/tn0022.txt

   1                         Making a new wxWidgets release
   2                         ==============================
   3
   4 Before making the release
   5 -------------------------
   6
   7 Update docs/readme.txt. Please review its contents in addition to just
   8 changing the version number.
   9
  10 Put a date on the release line in docs/changes.txt.
  11
  12 Update the date in the manual (docs/doxygen/mainpages/manual.h).
  13
  14 Mark the milestone corresponding to the previous release as being completed and
  15 create a new version and a new milestone for it in Trac admin web interface
  16 (ask Robin Dunn for password to access it).
  17
  18
  19 Creating release files
  20 ----------------------
  21
  22 Currently our release system uses a Python 2.x script to generate releases.
  23 The script requires Unix utilities such as tar, zip and unix2dos and thus must
  24 be run either on Unix or using Cygwin on Windows. To generate a release, simply
  25 run the following command:
  26
  27 build/tools/create-archive.py --compression=all /path/to/output/dir
  28
  29 This will produce zip, gzip and bzip archives of the tree (without
  30 "compression" argument only .gz is made). Note that this commands produces huge
  31 amounts of output so redirecting it to a file is recommended.
  32
  33 To add a prefix to the release, such as RC1, the SVN revision, or a date, just
  34 pass --postfix="postfix" to the script. More info on the options and their
  35 possible values can be found by calling `create-archive.py --help`.
  36
  37 IMPORTANT NOTE: You *must* run this script from a clean source tree, that is,
  38           with no junk files in it or modifications. This is because the
  39           release should be a pristine copy of the tree as of the time of
  40           release. If you have legitimate modifications in the tree that need
  41           to be in the release, commit them first.
  42
  43 To generate the windows installer (.exe) and the documentation files (chm and htb formats)
  44 run:
  45
  46 build\tools\bld_chm_exe.bat
  47
  48 which depends on the wxwidgets.iss file, and generates output in the %DAILY% directory. It
  49 assumes a clean copy of the wxWidgets source tree in %INNO%. Temporary files will be generated
  50 in the tree from which the batch file is run. It depends on doxygen, a number of gnu
  51 win32 tools and Microsofts htmlhelp compiler. The wxwidgets.iss file should not need
  52 editing, but you will want to check that the bld_chm_exe.bat has the correct version number.
  53
  54
  55
  56 Alternative non official release scripts
  57 ----------------------------------------
  58
  59 If you use git-svn, then you can use alternative script that avoids the
  60 problems such as using non-clean tree and also has better handling of the ends
  61 of lines conversions. To use it you need to run
  62
  63 - build/tools/svn-find-native-eols.pl
  64 - build/tools/git-make-release
  65 - build/tools/make-html-docs
  66
  67 (the last one can also be used without git).
  68
  69
  70 Uploading
  71 ---------
  72
  73 Upload the files to SourceForge. This can be done via the web interface or just
  74 scp to sfusername,wxwindows@frs.sf.net:/home/frs/project/w/wx/wxwindows/x.y.z
  75 You will need to use the web interface to mark the latest uploaded files as
  76 being "default downloads" for the appropriate platforms (.zip or .exe for MSW,
  77 .tar.bz2 for everything else) as otherwise SourceForge would continue to suggest
  78 people to download old files.
  79
  80 Also upload the files to the FTP mirror at ftp.wxwidgets.org (ask Chris for
  81 access if you don't have it).
  82
  83 Create http://docs.wxwidgets.org/x.y.z/ (ask Bryan to do it if not done yet).
  84
  85
  86 Announcement
  87 ------------
  88
  89 Post announcement at least to wx-announce@googlegroups.com.
  90
  91 TODO: where else to announce it?
  92
  93 Update www.wxwidgets.org, usually a news item is enough but something more can
  94 be called for for major releases.
  95
  96 Post to wxBlog if necessary.
  97
  98
  99 Version updates
 100 ---------------
 101
 102 Trac: mark the milestone corresponding to the release as completed and add a
 103 new version for it to allow reporting bugs against it (ask Vadim or Robin to do
 104 it).
 105
 106 Run misc/scripts/inc_release to increment micro version, i.e. replace x.y.z
 107 with x.y.z+1 (minor or major versions updates require manual intervention).