blob: 47deb0ac7afa6a5b01edccd7581e4dd427f30edb [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
27For each release candidate (should do release candidates for big releases,
28bug-fix-only releases might not need one):
29
30- Do pre-release testing:
31 - Make sure regtests run ok on all platforms of interest.
32 - Make sure Mozilla and OpenOffice run ok on all platforms of interest.
33
34- Change release number in AC_INIT() in configure.in to "X.Y.Z-rcN", where
35 'N' is the release candidate number.
36
37- Make the tarball ("make dist") and put it on the web somewhere (it doesn't
38 have to be on valgrind.org if another site is easier).
39
40- Announce the release:
41 - Email valgrind-users and valgrind-developers (but not valgrind-announce).
42 - Make clear it's a release candidate.
43 - Make sure you tell everyone where to download from.
44 - Include the release notes in the email (maybe not necessary for release
45 candidates 2+).
46
47- Wait 2--3 days for feedback. If bugs appear:
48 - Fix them.
49 - Update the bug-fix list in NEWS if necessary.
50 - Do another release candidate.
51
52
53For the official release:
54
55- Again, update date in docs/xml/vg-entities.xml for the official release
56 date.
57
58- Do pre-release testing:
59 - Make sure regtests run ok on all platforms of interest.
60 - Make sure Mozilla and OpenOffice run ok on all platforms of interest.
61
62- Change release number in AC_INIT() in configure.in to "X.Y.Z".
63
64- Tag the repository ("VALGRIND_X_Y_Z").
65
66- Make the tarball ("make dist").
67
68- Update website:
69 - Put the tarball up.
70 - Update www.valgrind.org/downloads/source_code.html.
71 - Add a news item to the front page and also to valgrind.org/info/news.html.
72
73- Change release number in AC_INIT() in configure.in to "X.Y.Z.SVN", where
74 X.Y.Z is one more than the release just done.
75
76- Announce the release:
77 - Email valgrind-users, valgrind-developers, and valgrind-announce.
78 - Include the release notes in the email.
79
80