From: Vadim Zeitlin Date: Thu, 22 Jul 2010 12:08:50 +0000 (+0000) Subject: Update the tech note about making new releases with more information. X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/8de577bc53608e14f1770047e414f6f316a99563 Update the tech note about making new releases with more information. Mention other release-related things and not only how to create the release files. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65036 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/tech/index.txt b/docs/tech/index.txt index 2dd0115a9e..b0fc874710 100644 --- a/docs/tech/index.txt +++ b/docs/tech/index.txt @@ -22,7 +22,7 @@ tn0018.txt How to add a new font encoding/charset to wxWidgets tn0019.txt Special notes about writing wxMSW code tn0020.txt Binary compatibility and wxWidgets tn0021.txt How to add a new wxUSE_XXX preprocessor constant -tn0022.txt Working with the wxWidgets release system +tn0022.txt Making a new release tn0023.txt Adding a new app/screenshot to the wxWidgets.org front page tn0024.txt How to add a new XRC handler diff --git a/docs/tech/tn0022.txt b/docs/tech/tn0022.txt index ffb995940a..f803caa26a 100644 --- a/docs/tech/tn0022.txt +++ b/docs/tech/tn0022.txt @@ -1,12 +1,8 @@ - Working with the wxWidgets release system - ========================================= - -Process Overview: -- run build/tools/create-archive.py --compression=all /path/to/output/dir -- upload release to sf.net -- update wxwidgets.org -- promote release on software download sites + Making a new wxWidgets release + ============================== +Creating release files +---------------------- Currently our release system uses a Python 2.x script to generate releases. The script requires Unix utilities such as tar, zip and unix2dos and thus must @@ -29,3 +25,40 @@ IMPORTANT NOTE: You *must* run this script from a clean source tree, that is, release. If you have legitimate modifications in the tree that need to be in the release, commit them first. + +Also run doxygen to create HTML documentation and pack it in .tar.bz2 and .zip +formats. + + +Uploading +--------- + +Upload the files to SourceForge (the simplest is to scp them to +sfusername,wxwindows@frs.sf.net:/home/frs/project/w/wx/wxwindows/x.y.z) and to +ftp.wxwidgets.org (ask Chris to do it). + +Create http://docs.wxwidgets.org/x.y.z/ (ask Bryan to do it). + + +Announcement +------------ + +Post announcement at least to wx-announce@googlegroups.com. + +TODO: where else to announce it? + +Update www.wxwidgets.org, usually a news item is enough but something more can +be called for for major releases. + +Post to wxBlog if necessary. + + +Version updates +--------------- + +Trac: mark the milestone corresponding to the release as completed and add a +new version for it to allow reporting bugs against it (ask Vadim or Robin to do +it). + +Run misc/scripts/inc_release to increment micro version, i.e. replace x.y.z +with x.y.z+1 (minor or major versions updates require manual intervention).