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