njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 1 | ----------------------------------------------------------------------------- |
| 2 | TODO list when doing a Valgrind release (with release number "X.Y.Z") |
| 3 | ----------------------------------------------------------------------------- |
| 4 | |
| 5 | First 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 |
sewardj | 9a91951 | 2005-08-03 17:01:51 +0000 | [diff] [blame] | 18 | Bugzilla. It's unclear how to do this consistently. The approach |
| 19 | taken for 3.0.0 was to go to this page in KDE's bugzilla: |
| 20 | http://bugs.kde.org/query.cgi |
| 21 | and to create a search where |
| 22 | "Status and severity" / Status field is set to RESOLVED |
| 23 | and |
| 24 | "Involved People" / Email, bug-owner contains "jseward" |
| 25 | since I believe jseward@acm.org is the owner of all bugs. |
| 26 | This creates a long list of bugs which does not conveniently stop |
| 27 | at the previous release. Work backwards through this list until |
| 28 | either (1) you run out of patience, or (2) most of the bugs seem |
| 29 | to pertain to previous releases and are now irrelevant. In short |
| 30 | this is not a very scientific or robust way to collect up all |
| 31 | bugs fixed since last time. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 32 | |
njn | a920d8a | 2005-07-26 22:17:14 +0000 | [diff] [blame] | 33 | - Other files that might need updating: README, README_DEVELOPERS, |
| 34 | README_PACKAGERS. |
| 35 | |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 36 | - Add X.Y.Z and X.Y.Z.SVN versions to Bugzilla (ask Dirk to do it) |
| 37 | |
njn | 12c9095 | 2005-07-25 12:49:39 +0000 | [diff] [blame] | 38 | - If there are any binary incompatible tool API changes against the last |
| 39 | stable release, ensure that VG_CORE_INTERFACE_VERSION in |
| 40 | include/pub_tool_tooliface.h has been increased since the last release. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 41 | |
njn | 85773ee | 2005-07-25 23:30:06 +0000 | [diff] [blame] | 42 | |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 43 | For each release candidate (should do release candidates for big releases, |
| 44 | bug-fix-only releases might not need one): |
| 45 | |
| 46 | - Do pre-release testing: |
| 47 | - Make sure regtests run ok on all platforms of interest. |
| 48 | - Make sure Mozilla and OpenOffice run ok on all platforms of interest. |
| 49 | |
| 50 | - Change release number in AC_INIT() in configure.in to "X.Y.Z-rcN", where |
| 51 | 'N' is the release candidate number. |
| 52 | |
| 53 | - Make the tarball ("make dist") and put it on the web somewhere (it doesn't |
| 54 | have to be on valgrind.org if another site is easier). |
| 55 | |
sewardj | 61ff456 | 2005-07-25 23:50:22 +0000 | [diff] [blame] | 56 | - Ensure the tarball builds, runs, regtests on the platforms of interest. |
| 57 | However redundant this seems, sometimes it can be that a from-the-repo |
| 58 | build works whereas a from-the-tarball one doesn't, usually due to some |
| 59 | trivial installation problem. |
| 60 | |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 61 | - Announce the release: |
| 62 | - Email valgrind-users and valgrind-developers (but not valgrind-announce). |
| 63 | - Make clear it's a release candidate. |
| 64 | - Make sure you tell everyone where to download from. |
| 65 | - Include the release notes in the email (maybe not necessary for release |
| 66 | candidates 2+). |
| 67 | |
| 68 | - Wait 2--3 days for feedback. If bugs appear: |
| 69 | - Fix them. |
| 70 | - Update the bug-fix list in NEWS if necessary. |
| 71 | - Do another release candidate. |
| 72 | |
| 73 | |
| 74 | For the official release: |
| 75 | |
| 76 | - Again, update date in docs/xml/vg-entities.xml for the official release |
| 77 | date. |
| 78 | |
| 79 | - Do pre-release testing: |
| 80 | - Make sure regtests run ok on all platforms of interest. |
| 81 | - Make sure Mozilla and OpenOffice run ok on all platforms of interest. |
| 82 | |
| 83 | - Change release number in AC_INIT() in configure.in to "X.Y.Z". |
| 84 | |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 85 | - Make the tarball ("make dist"). |
sewardj | 61ff456 | 2005-07-25 23:50:22 +0000 | [diff] [blame] | 86 | |
| 87 | - Check tarball builds, installs, regtests on platforms of interest. |
| 88 | If not, fix and repeat until success. |
| 89 | |
| 90 | - Tag the repository ("VALGRIND_X_Y_Z"). |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 91 | |
| 92 | - Update website: |
| 93 | - Put the tarball up. |
njn | a920d8a | 2005-07-26 22:17:14 +0000 | [diff] [blame] | 94 | - Update the docs -- both the tarball'd docs, and the online-readable docs. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 95 | - Update www.valgrind.org/downloads/source_code.html. |
njn | a920d8a | 2005-07-26 22:17:14 +0000 | [diff] [blame] | 96 | - Update www.valgrind.org/downloads/archive.html. |
njn | 4b42c22 | 2005-08-27 17:31:43 +0000 | [diff] [blame] | 97 | - Put the release notes at www.valgrind.org/info/release-notes-X.Y.Z.txt. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 98 | - Add a news item to the front page and also to valgrind.org/info/news.html. |
njn | 4b42c22 | 2005-08-27 17:31:43 +0000 | [diff] [blame] | 99 | Include a link to the release notes. |
njn | bdbcacd | 2005-08-01 15:18:16 +0000 | [diff] [blame] | 100 | - Update the "release-date" and "release-version" in php/.htconfx. |
njn | a920d8a | 2005-07-26 22:17:14 +0000 | [diff] [blame] | 101 | - Other pages that might need updating: devel/cvs_svn.html. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 102 | |
| 103 | - Change release number in AC_INIT() in configure.in to "X.Y.Z.SVN", where |
| 104 | X.Y.Z is one more than the release just done. |
| 105 | |
njn | 32ac364 | 2005-08-29 22:24:20 +0000 | [diff] [blame] | 106 | - Add a new section to docs/internals/X_Y_BUGSTATUS.txt. |
| 107 | |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 108 | - Announce the release: |
sewardj | 61ff456 | 2005-07-25 23:50:22 +0000 | [diff] [blame] | 109 | - Email valgrind-users, valgrind-developers, and valgrind-announce. |
| 110 | - Email Linux Weekly News. |
njn | af66ea6 | 2005-07-24 23:47:01 +0000 | [diff] [blame] | 111 | - Include the release notes in the email. |
| 112 | |
sewardj | 61ff456 | 2005-07-25 23:50:22 +0000 | [diff] [blame] | 113 | - Go on holiday. |