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