projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 8de577bc VZ |
1 | Making a new wxWidgets release |
| 2 | ============================== | |
| c7f200e9 | 3 | |
| 8de577bc VZ |
4 | Creating release files |
| 5 | ---------------------- | |
| c7f200e9 | 6 | |
| 433400df VZ |
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: | |
| c7428e08 KO |
11 | |
| 12 | build/tools/create-archive.py --compression=all /path/to/output/dir | |
| 13 | ||
| 433400df VZ |
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. | |
| c7428e08 | 17 | |
| 433400df VZ |
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`. | |
| c7428e08 | 21 | |
| 433400df VZ |
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. | |
| c7428e08 | 27 | |
| 8de577bc VZ |
28 | |
| 29 | Also run doxygen to create HTML documentation and pack it in .tar.bz2 and .zip | |
| 30 | formats. | |
| 31 | ||
| 32 | ||
| 33 | Uploading | |
| 34 | --------- | |
| 35 | ||
| 36 | Upload the files to SourceForge (the simplest is to scp them to | |
| 37 | sfusername,wxwindows@frs.sf.net:/home/frs/project/w/wx/wxwindows/x.y.z) and to | |
| 38 | ftp.wxwidgets.org (ask Chris to do it). | |
| 39 | ||
| 40 | Create http://docs.wxwidgets.org/x.y.z/ (ask Bryan to do it). | |
| 41 | ||
| 42 | ||
| 43 | Announcement | |
| 44 | ------------ | |
| 45 | ||
| 46 | Post announcement at least to wx-announce@googlegroups.com. | |
| 47 | ||
| 48 | TODO: where else to announce it? | |
| 49 | ||
| 50 | Update www.wxwidgets.org, usually a news item is enough but something more can | |
| 51 | be called for for major releases. | |
| 52 | ||
| 53 | Post to wxBlog if necessary. | |
| 54 | ||
| 55 | ||
| 56 | Version updates | |
| 57 | --------------- | |
| 58 | ||
| 59 | Trac: mark the milestone corresponding to the release as completed and add a | |
| 60 | new version for it to allow reporting bugs against it (ask Vadim or Robin to do | |
| 61 | it). | |
| 62 | ||
| 63 | Run misc/scripts/inc_release to increment micro version, i.e. replace x.y.z | |
| 64 | with x.y.z+1 (minor or major versions updates require manual intervention). |