* including scroll_tool.h
[dia.git] / RELEASE-PROCESS
blob288c4711728979f03f3df4f3030a457c2ea0208d
1 Status
2 ------
4 This document, at this point, is a proposal only. It attempts to
5 document how we intend to make the upcoming releases, in order to make
6 as sure as possible no stupid bugs creep in just before the release.
8 Contents
9 --------
11 When a new version is about to be released:
13 0) Day Zero (D+0): The core developers announce their intention of
14    making a new release. They call for a feature freeze on the CVS
15    HEAD (bug fixes are okay to commit). They also announce the
16    provisional duration of the freeze before the first release
17    candidate tarball is about to be made (actual freeze duration may vary for
18    instance according to the perceived amount of changes since the
19    last release; for the purpose of this document, it's assumed to be
20    three days).
22    Advanced users are encouraged to download the CVS HEAD or the
23    snapshot tarballs, and pound on them.
25 1) The core developers agree on the next version number. It's called
26    $VERSION thereafter. 
28 2) D+3: a release candidate tarball is made. It is called
29    $VERSION-pre1. Simultaneously, a CVS tag is made with the name
30    "DIA_$VERSION_PRE1" (with the non-alphanumeric characters in
31    $VERSION replaced by underscores). $VERSION-pre1 is registered with
32    the Bugzilla, however it is encouraged that bug reports are made
33    directly (or simultaneously) to the mailing list.
35    Please see the section below on how to make a tarball (yes, please do).
37 3a) if a release-critical bug happens before D+10 (say, at D+n), the
38    release process is paused until the bug is fixed and a new release
39    candidate tarball $VERSION-pre2 is re-made. Go to either step 3a or
40    3b with D+10 replaced by D+n+10.
42 3b) D+10: if there are no release-critical bugs in the pre-release,
43    then the same source (fetched from the CVS tag) is rebuilt with the
44    final $VERSION number (and the resulting "new" version is re-tagged
45    in CVS). $VERSION is registered with the Bugzilla, and all
46    $VERSION-preX are removed (from now on, bugs against -preX are
47    rejected as INVALID).
49 4) once the new release is complete and uploaded, announcements on
50    freshmeat, the dia web site, the dia mailing list,
51    gnome-announce-list@gnome.org and maybe a gnotices story
52    (news.gnome.org) are made. 
54 5) the CVS HEAD freeze is lifted one week /after/ the release is
55    generally available, unless a release critical bug is discovered in
56    the release. If the latter is the case, a new, fixed "brown bag" release is
57    released and announced as soon as possible (extending the one-week
58    delay on the CVS HEAD thaw).
60 How to make a tarball
61 ---------------------
62   1. make sure you have up to date build tools installed on the system.
63       Libtool is an important one, as new releases add support for new
64      platforms.
65   2. make sure "make distcheck" runs to completion.  With automake >=
66      1.5, the checks also make sure "make uninstall" removes all files 
67      that got installed.
68   3. check to see if the tarball builds in normal and --enable-gnome
69      modes (this task should disapear with the move to 2.0; there is no
70      reason to have separate dialog and menu code).
71   4. Upload to ftp.gnome.org.  This is basically just scp'ing the
72      tarball to widget.gnome.org, then running a command like
73      "install-module dia-0.90.tar.gz", which will create bz2
74      tarballs, diffs to the previous version, and signal the ftp mirrors
75      (currently just ftp.gnome.org and planetmirror.com) to synchronise. 
77 Issues to solve
78 ---------------
80 agreeing on how to properly handle the case of having only ten two-decimal
81 place version numbers until we hit 1.0 
83 Files
84 -----
86 These files need to be updated at every release:
88 config.h.win32
89 News
90 configure.in
91 doc/en/dia-manual.sgml?
92 dia.spec (note that the preN should go in release, not ver.
94 Webpages
95 --------
97 Remember to also update the webpages.  In particular, the download page,
98 the NEWS page and the FAQ needs updating.