docs/internals/release-HOWTO.txt

   1 -----------------------------------------------------------------------------
   2 TODO list when doing a Valgrind release (with release number "X.Y.Z")
   3 -----------------------------------------------------------------------------
   4
   5 There are two kinds of releases:
   6
   7 - Feature releases:  X.Y.0, which can include new features.
   8
   9 - Bug-fix releases:  X.Y.[12...], which only include bug fixes.
  10
  11
  12 First of all:
  13
  14 - Tell valgrind-developers you want to do a release.  Give a timeframe for
  15   everyone to check in any final features/bug-fixes they want in the
  16   release.
  17
  18 - Go over the docs, make sure they're up to date.
  19
  20 - Update version number and date in docs/xml/vg-entities.xml.  (Exact
  21   release date probably won't be known yet, updating it is in the list below
  22   of tasks for the official release.)
  23
  24 - Make sure __VALGRIND_MAJOR__ and __VALGRIND_MINOR__ are correct
  25   for the release.  (include/valgrind.h)
  26
  27 - Write release notes, add to NEWS.  Include a list of fixed bugs from
  28   Bugzilla.  It's unclear how to do this consistently.  The approach
  29   taken for 3.0.0 was to go to this page in KDE's bugzilla:
  30      http://bugs.kde.org/query.cgi
  31   and to create a search where
  32      "Status and severity" / Status field is set to RESOLVED
  33   and
  34      "Involved People" / Email, bug-owner contains "jseward"
  35   since I believe jseward@acm.org is the owner of all bugs.
  36   This creates a long list of bugs which does not conveniently stop
  37   at the previous release.  Work backwards through this list until
  38   either (1) you run out of patience, or (2) most of the bugs seem
  39   to pertain to previous releases and are now irrelevant.  In short
  40   this is not a very scientific or robust way to collect up all
  41   bugs fixed since last time.
  42
  43   Suggestion for next release: when a bug is fixed, update NEWS
  44   directly => less chance to forget, and NEWS always up to date
  45   in GIT.
  46
  47 - Other files that might need updating:  README, README_DEVELOPERS,
  48   README_PACKAGERS.
  49
  50 - Add X.Y.Z and X.Y+1.Z.GIT versions to Bugzilla.
  51
  52 - Add "wantedX.Y.Z+1" and "wantedX.Y+1.Z" milestones to Bugzilla.
  53
  54 - Check whether copyright years need updating.
  55   If so, run  auxprogs/change-copyright-year  in the top of the tree.
  56
  57 - Consider upgrading the C++ demangler.
  58   auxprogs/update-demangler   helps with that
  59
  60 - Contact Gregory Czajkowski ( gregczajkowski@yahoo.com ) and ask him
  61   to build (make && make check) valgrind with ICC.
  62
  63 For each release candidate (should do release candidates for feature
  64 releases, bug-fix-only releases might not need one):
  65
  66 - Build.
  67
  68 - Do pre-release testing:
  69
  70   * Check it builds and regtests on a vanilla gcc-2.96 / RedHat 7.3 distro.
  71   ??? is this really still up to date ???
  72
  73   * Check standard build and regtest on the following cpus:
  74        x86, sse2 (P4)
  75        x86, sse1 (PIII)
  76        x86, no sse (eg older VIA C3s, or perhaps even Pentium-MMX)
  77        amd64
  78        ppc32, altivec
  79        ppc32, no altivec (eg old iMac G3s)
  80
  81   * Check that the regression tests work on all platforms with more self checks:
  82      export EXTRA_REGTEST_OPTS="--sanity-level=4 --helgrind:hg-sanity-flags=011111"
  83      make regtest
  84
  85   * check there are no memleaks or similar bugs by running all regtests
  86     in an outer/inner setup (see README_DEVELOPERS).
  87
  88   * Check valgrind-listener works on all archs, also connecting to it
  89     from all archs.
  90
  91   * Check memcheck can run all the insn-set tests.  The testsuite
  92     only runs those on 'none', but memcheck looks at all primops, and I've
  93     been caught out by this before.  Basically all the programs in
  94     none/tests/{x86,amd64,ppc32}.
  95
  96   * Check XML output is still readable by Valkyrie and vk_logmerge tools
  97
  98   * Test with large applications (firefox and OOo 2.0) on all platforms.
  99
 100   * Run regression tests from gsl-1.6 on all platforms.  This is a good,
 101     thorough test of FP.  Easy, using the scripts auxprogs/gsl16test.
 102
 103   * s390x: Run regression tests on a z900 machine. That is the oldest
 104     supported model and there is no nightly build for it.
 105
 106   * s390x: Ensure README.s390 is up-to-date and URLs therein are not stale.
 107
 108 - Change release number in AC_INIT() in configure.in to "X.Y.Z-rcN", where
 109   'N' is the release candidate number.
 110
 111 - Make the tarball ("make dist") and put it on the web somewhere (it doesn't
 112   have to be on valgrind.org if another site is easier).
 113
 114 - Ensure the tarball builds, runs, regtests on the platforms of interest.
 115   However redundant this seems, sometimes it can be that a from-the-repo
 116   build works whereas a from-the-tarball one doesn't, usually due to some
 117   trivial installation problem.
 118
 119 - Also check the HTML and print docs look sane (eg. links work).  And the
 120   man pages, esp. that there are no broken references (look for "???").
 121
 122 - Announce the release:
 123   - Email valgrind-users and valgrind-developers (but not valgrind-announce).
 124   - Make clear it's a release candidate.
 125   - Make sure you tell everyone where to download from.
 126   - Include the release notes in the email (maybe not necessary for release
 127     candidates 2+).
 128
 129 - Wait 2--3 days for feedback.  If bugs appear:
 130   - Fix them.
 131   - Update the bug-fix list in NEWS if necessary.
 132   - Do another release candidate.
 133
 134
 135 For the official release:
 136
 137 - Again, update date in docs/xml/vg-entities.xml for the official release
 138   date.
 139
 140 - Do pre-release testing:
 141   - Make sure regtests run ok on all platforms of interest.
 142   - Make sure Mozilla and OpenOffice run ok on all platforms of interest.
 143
 144 - Change release number in AC_INIT() in configure.ac to "X.Y.Z".
 145
 146 - Make the tarball ("make dist").
 147
 148 - Check tarball builds, installs, regtests on platforms of interest.
 149   If not, fix and repeat until success.
 150
 151 - Tag the repository ("VALGRIND_X_Y_Z").
 152
 153   If it's a X.Y.0 release, make "VALGRIND_X_Y_BRANCH" branch, too.
 154   Useful examples (X.Y.0 major release):
 155
 156     cd valgrind
 157     git checkout HEAD
 158     git tag VALGRIND_3_3_0
 159     git branch VALGRIND_3_3_BRANCH
 160     git push
 161
 162   (X.Y.Z minor release):
 163
 164     cd valgrind
 165     git checkout VALGRIND_3_6_BRANCH
 166     git tag VALGRIND_3_6_1
 167     git push
 168
 169
 170 - Update website:
 171   - Put the tarball up.
 172   - Update the docs -- both the tarball'd docs, and the online-readable docs.
 173   - Update www.valgrind.org/downloads/current.html.
 174   - Update www.valgrind.org/downloads/old.html.
 175   - Add a news item to the front page and also to valgrind.org/info/news.html.
 176     Include a link to the release notes.  Possibly remove any old release
 177     notices form the front page.
 178   - Update the "release-date" and "release-version" in php/.htconfx.
 179   - Other pages that might need updating:  downloads/repository.html.
 180
 181 - Change release number in AC_INIT() in configure.ac to "X.Y.Z.GIT", where
 182   X.Y.Z is one more than the release just done.
 183
 184 - Make sure the release notes are present in the NEWS file on the master and
 185   the branch.
 186
 187 - Announce the release:
 188   - Email valgrind-users, valgrind-developers, and valgrind-announce.
 189   - Email Linux Weekly News.
 190   - Include the release notes in the email.
 191
 192 - Go on holiday.