.cvsignores added.
[dia.git] / RELEASE-PROCESS
blob0d9b7757b91969a5fac8309f2c7ad2587996b3e7
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    Make sure to check for open Bugzilla bugs with the PATCH keyword.
27    If there are enough changes that a security audit is appropriate
28    (e.g. new or changed importers), there is a standing offer from infamous
29    <infamous41md@sol-biotech.com> to get audits.
31 1) The core developers agree on the next version number. It's called
32    $VERSION thereafter. They also look if DIA_PLUGIN_API_VERSION needs
33    to be updated.
35 2) D+3: a release candidate tarball is made. It is called
36    $VERSION-pre1. Simultaneously, a CVS branch is made with the name
37    "DIA_$VERSION_RELEASE" (with the non-alphanumeric characters in $VERSION
38    replaced by underscores, e.g. cvs tag -b DIA_0_93_RELEASE).
39    $VERSION-pre1 is registered with the Bugzilla, however it is encouraged
40    that bug reports are made directly (or simultaneously) to the mailing
41    list.
43    Please see the section below on how to make a tarball (yes, please do).
45    Translators, as pulled from the Translation-Team: field in the .po
46    files, are notified of the upcoming release to give them time to
47    translate new strings.  No further changes to translatable strings
48    should happen from now till the final release ("string freeze").
49    Also mail gnome-i18n@gnome.org to notify the Gnome Translation Project
50    (and perhaps get new translators).
52 3a) if a release-critical bug happens before D+10 (say, at D+n), the
53    release process is paused until the bug is fixed and a new release
54    candidate tarball $VERSION-pre2 is re-made. Go to either step 3a or
55    3b with D+10 replaced by D+n+10.  Any bugs fixed that way, as well as
56    further translations, must be transferred back into the main trunk
57    (cvs update -j).
59 3b) D+10: if there are no release-critical bugs in the pre-release,
60    then the same source (fetched from the CVS branch) is rebuilt with the
61    final $VERSION number (and the resulting "new" version is re-tagged
62    in CVS). $VERSION is registered with the Bugzilla, and all
63    $VERSION-preX are removed (from now on, bugs against -preX are
64    rejected as INVALID).
66 4) once the new release is complete and uploaded, announcements on
67    freshmeat, the dia web site, the dia mailing list,
68    gnome-announce-list@gnome.org, gnomefiles.org and maybe a gnotices story
69    (news.gnome.org) are made.  Alerting the package maintainers for the
70    various distributions is also a good idea, get names from MAINTAINERS
71    and update those who have changed.
73 5) the CVS HEAD freeze is lifted one week /after/ the release is
74    generally available, unless a release critical bug is discovered in
75    the release. If the latter is the case, a new, fixed "brown bag" release is
76    released and announced as soon as possible (extending the one-week
77    delay on the CVS HEAD thaw).
79    Once the head is lifted, the release branch is considered dead and
80    should no longer be used.
82 How to make a tarball
83 ---------------------
84   1. Update the version number in configure.in, config.h.win32,
85      doc/{en,eu,pl}/dia.xml.  Also update dia.spec when changing
86      the version number, but not for a change of prerelease number.
87   2. Add information about things that have changed to the NEWS file.
88   3. make sure you have up to date build tools installed on the system.
89       Libtool is an important one, as new releases add support for new
90      platforms.  Also consider updating intltool
91   4. make sure "make distcheck" runs to completion.  With automake >=
92      1.5, the checks also make sure "make uninstall" removes all files 
93      that got installed.
94   5. check to see if the tarball builds in normal and --enable-gnome
95      modes (this task should disapear with the move to 2.0; there is no
96      reason to have separate dialog and menu code).
97   6. Upload to ftp.gnome.org.  This is basically just scp'ing the
98      tarball to widget.gnome.org, then running a command like
99      "install-module dia-0.90.tar.gz", which will create bz2
100      tarballs, diffs to the previous version, and signal the ftp mirrors
101      (currently just ftp.gnome.org and planetmirror.com) to synchronise. 
103 Script to update version:
105 find . -name configure.in -o -name config.h.win32 -o -name dia.xml  | xargs sed -i 's/0\.95*/0.95-1/;'
107 Issues to solve
108 ---------------
110 agreeing on how to properly handle the case of having only ten two-decimal
111 place version numbers until we hit 1.0 
113 How do we notify people that a) a prerelease branch is where translation
114 goes and b) the prerelease branch is dead when it is.
116 Files
117 -----
119 These files need to be updated at every release:
121 config.h.win32
122 NEWS
123 configure.in
124 doc/{en,pl}/dia.xml
125 dia.spec (note that the preN should go in release, not ver).
127 Webpages
128 --------
130 Remember to also update the webpages.  In particular, the download page,
131 the NEWS page and the FAQ needs updating.