|
From: <sv...@va...> - 2005-07-24 23:47:08
|
Author: njn
Date: 2005-07-25 00:47:01 +0100 (Mon, 25 Jul 2005)
New Revision: 4245
Log:
Added a checklist of things to do when doing a release. Please add to th=
is
if you think of anything that is missing.
Added:
trunk/docs/internals/release-HOWTO
Modified:
trunk/docs/internals/Makefile.am
Modified: trunk/docs/internals/Makefile.am
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/internals/Makefile.am 2005-07-24 23:21:28 UTC (rev 4244)
+++ trunk/docs/internals/Makefile.am 2005-07-24 23:47:01 UTC (rev 4245)
@@ -1,6 +1,8 @@
EXTRA_DIST =3D \
64-bit-cleanness.txt directory-structure.txt m_replacemalloc.txt \
m_syswrap.txt module-structure.txt notes.txt porting-HOWTO.txt \
- porting-to-ARM.txt segments-seginfos.txt threads-syscalls-signals.txt \
+ porting-to-ARM.txt \
+ release-HOWTO \
+ segments-seginfos.txt threads-syscalls-signals.txt \
tm-mutexstates.dot tm-threadstates.dot tracking-fn-entry-exit.txt \
xml-output.txt
Added: trunk/docs/internals/release-HOWTO
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/internals/release-HOWTO 2005-07-24 23:21:28 UTC (rev 4244)
+++ trunk/docs/internals/release-HOWTO 2005-07-24 23:47:01 UTC (rev 4245)
@@ -0,0 +1,77 @@
+------------------------------------------------------------------------=
-----
+TODO list when doing a Valgrind release (with release number "X.Y.Z")
+------------------------------------------------------------------------=
-----
+
+First of all:
+
+- Tell valgrind-developers you want to do a release. Give a timeframe f=
or
+ everyone to check in any final features/bug-fixes they want in the
+ release.
+
+- Go over the docs, make sure they're up to date.
+
+- Update version number and date in docs/xml/vg-entities.xml. (Exact
+ release date probably won't be known yet, updating it is in the list b=
elow
+ of tasks for the official release.)
+
+- Write release notes, add to NEWS. Include a list of fixed bugs from
+ Bugzilla. [[We should decide a defined way of obtaining this list so =
it's
+ consistent and so we don't have to work it out anew each time.]]
+
+- Add X.Y.Z and X.Y.Z.SVN versions to Bugzilla (ask Dirk to do it)
+
+
+For each release candidate (should do release candidates for big release=
s,
+bug-fix-only releases might not need one):
+
+- Do pre-release testing:
+ - Make sure regtests run ok on all platforms of interest.
+ - Make sure Mozilla and OpenOffice run ok on all platforms of interest=
.
+
+- Change release number in AC_INIT() in configure.in to "X.Y.Z-rcN", whe=
re
+ 'N' is the release candidate number.
+
+- Make the tarball ("make dist") and put it on the web somewhere (it doe=
sn't
+ have to be on valgrind.org if another site is easier).
+
+- Announce the release:
+ - Email valgrind-users and valgrind-developers (but not valgrind-annou=
nce). =20
+ - Make clear it's a release candidate. =20
+ - Make sure you tell everyone where to download from.
+ - Include the release notes in the email (maybe not necessary for rele=
ase
+ candidates 2+).
+
+- Wait 2--3 days for feedback. If bugs appear:
+ - Fix them.
+ - Update the bug-fix list in NEWS if necessary.
+ - Do another release candidate.
+
+
+For the official release:
+
+- Again, update date in docs/xml/vg-entities.xml for the official releas=
e
+ date.
+
+- Do pre-release testing:
+ - Make sure regtests run ok on all platforms of interest.
+ - Make sure Mozilla and OpenOffice run ok on all platforms of interest=
.
+
+- Change release number in AC_INIT() in configure.in to "X.Y.Z".
+
+- Tag the repository ("VALGRIND_X_Y_Z").
+
+- Make the tarball ("make dist").
+ =20
+- Update website:=20
+ - Put the tarball up.
+ - Update www.valgrind.org/downloads/source_code.html. =20
+ - Add a news item to the front page and also to valgrind.org/info/news=
.html.
+
+- Change release number in AC_INIT() in configure.in to "X.Y.Z.SVN", whe=
re
+ X.Y.Z is one more than the release just done.
+
+- Announce the release:
+ - Email valgrind-users, valgrind-developers, and valgrind-announce. =20
+ - Include the release notes in the email.
+
+
|