blob: 44533b8f2c5e00c547cd3b3de7707b7d123cd64b [file] [log] [blame]
njnaf66ea62005-07-24 23:47:01 +00001-----------------------------------------------------------------------------
2TODO list when doing a Valgrind release (with release number "X.Y.Z")
3-----------------------------------------------------------------------------
4
5First of all:
6
7- Tell valgrind-developers you want to do a release. Give a timeframe for
8 everyone to check in any final features/bug-fixes they want in the
9 release.
10
11- Go over the docs, make sure they're up to date.
12
13- Update version number and date in docs/xml/vg-entities.xml. (Exact
14 release date probably won't be known yet, updating it is in the list below
15 of tasks for the official release.)
16
17- Write release notes, add to NEWS. Include a list of fixed bugs from
18 Bugzilla. [[We should decide a defined way of obtaining this list so it's
19 consistent and so we don't have to work it out anew each time.]]
20
21- Add X.Y.Z and X.Y.Z.SVN versions to Bugzilla (ask Dirk to do it)
22
njn12c90952005-07-25 12:49:39 +000023- If there are any binary incompatible tool API changes against the last
24 stable release, ensure that VG_CORE_INTERFACE_VERSION in
25 include/pub_tool_tooliface.h has been increased since the last release.
njnaf66ea62005-07-24 23:47:01 +000026
njn85773ee2005-07-25 23:30:06 +000027
njnaf66ea62005-07-24 23:47:01 +000028For each release candidate (should do release candidates for big releases,
29bug-fix-only releases might not need one):
30
31- Do pre-release testing:
32 - Make sure regtests run ok on all platforms of interest.
33 - Make sure Mozilla and OpenOffice run ok on all platforms of interest.
34
35- Change release number in AC_INIT() in configure.in to "X.Y.Z-rcN", where
36 'N' is the release candidate number.
37
38- Make the tarball ("make dist") and put it on the web somewhere (it doesn't
39 have to be on valgrind.org if another site is easier).
40
41- Announce the release:
42 - Email valgrind-users and valgrind-developers (but not valgrind-announce).
43 - Make clear it's a release candidate.
44 - Make sure you tell everyone where to download from.
45 - Include the release notes in the email (maybe not necessary for release
46 candidates 2+).
47
48- Wait 2--3 days for feedback. If bugs appear:
49 - Fix them.
50 - Update the bug-fix list in NEWS if necessary.
51 - Do another release candidate.
52
53
54For the official release:
55
56- Again, update date in docs/xml/vg-entities.xml for the official release
57 date.
58
59- Do pre-release testing:
60 - Make sure regtests run ok on all platforms of interest.
61 - Make sure Mozilla and OpenOffice run ok on all platforms of interest.
62
63- Change release number in AC_INIT() in configure.in to "X.Y.Z".
64
65- Tag the repository ("VALGRIND_X_Y_Z").
66
67- Make the tarball ("make dist").
68
69- Update website:
70 - Put the tarball up.
njn85773ee2005-07-25 23:30:06 +000071 - Update the docs at www.valgrind.org/ (?)
njnaf66ea62005-07-24 23:47:01 +000072 - Update www.valgrind.org/downloads/source_code.html.
73 - Add a news item to the front page and also to valgrind.org/info/news.html.
74
75- Change release number in AC_INIT() in configure.in to "X.Y.Z.SVN", where
76 X.Y.Z is one more than the release just done.
77
78- Announce the release:
79 - Email valgrind-users, valgrind-developers, and valgrind-announce.
80 - Include the release notes in the email.
81
82