release revision fdf2eaf21bf4530114049f3c77421a56d585aabc
cd348e325366620fe047edcc849e3c9424828599Peter BrayaCopyright (C) 2000, 2001 Internet Software Consortium.
cd348e325366620fe047edcc849e3c9424828599Peter BraySee COPYRIGHT in the source root or http://isc.org/copyright.html for terms.
cd348e325366620fe047edcc849e3c9424828599Peter Bray$Id: release,v 1.50 2001/11/22 00:35:36 gson Exp $
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayPreparing a bind9 release
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayHere's a rough outline of the steps to follow in preparing a new bind9
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Update the README file
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Send the new README file to webteam@nominum.com at least 48
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray hours prior to the planned release and ask them to prepare
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray the web pages for the new version. If there have been only
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray minor changes, send context diffs relative to the previous
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray release instead.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Do a "cvs update" to check that all changes have been committed.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Verify that the file "version" contains the correct version
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray number (it should have been incremented after the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray previous release)
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal - Before creating a new release branch, update the lib/*/api files
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal as needed. See the libtool info file for information about what
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray the various numbers mean.
cd71fb134e037849c77364b50940b1870c4684ceVladimir Kotal - If building from a release branch, check that any important
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray bug fixes made on the mainline since the last release have
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray been pulled up. You can do this by comparing the CHANGES
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray files using the util/check-pullups.pl script. For example,
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray running the script from a mainline tree:
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal perl util/check-pullups.pl CHANGES ../9.2/CHANGES
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray This will list all bug fixes on the mainline that are not
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray on the 9.2 release branch.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal - Check that http://status.isc.org/bind9/bind9.html
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal shows a clean build and test status for all supported
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal systems and that the tests are actually being run on the
b17cb0705d90907337b3528aa7b8ed1700806f26Vladimir Kotal version being released (the version can be found in the
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal page behind the "Source tar build" link).
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal - Check that running "make all_tests" in bin/tests does not
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal produce compile errors.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal - Regenerate the documentation by running "make man" (mainline/9.2)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal or by running genhtml.sh in doc/arm (9.1 release branch)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal and commit it. Note that not all machines have the
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal necessary XML tools, but at least trebuchet, cuba,
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal and Scanner's machine do. Commit any files that were
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal - Verify that the documents in doc/misc are up-to-date.
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray - Update the copyrights. According to tale:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Go to the root of the source tree.
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco The scripts need to be run from there; they reference the util
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal subdirectory internally.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal $ make distclean
cd348e325366620fe047edcc849e3c9424828599Peter Bray ... [I prefer to check out a fresh source tree --gson]
cd348e325366620fe047edcc849e3c9424828599Peter Bray ... examine output, particularly any files with the "?" type, and
cd348e325366620fe047edcc849e3c9424828599Peter Bray ... then edit util/newcopyrights if necessary
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal $ cvs ci -m'merge_copyrights' util/copyrights
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal $ perl util/update_copyrights < util/copyrights
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco ... examine output, edit as necessary. mail me about anything that
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco ... the script should have been able to do itself. :-)
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco $ cvs ci -m'update_copyrights'
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco - Announce a CVS freeze if doing an alpha or beta release from
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco the mainline, or stop doing pullups if building from a release branch.
f21b682cd9b414738a4f5a38b56f6682e537e1d2Trond Norbye - Run util/altbuild.sh. This is to make sure that
f21b682cd9b414738a4f5a38b56f6682e537e1d2Trond Norbye builds using libtool, separate source/object directories, and other
f21b682cd9b414738a4f5a38b56f6682e537e1d2Trond Norbye obscure build options work. This script may need some hacking if run
cd348e325366620fe047edcc849e3c9424828599Peter Bray on anything other than NetBSD. Save the output (it's big) and look
cd348e325366620fe047edcc849e3c9424828599Peter Bray for error and warning messages.
cd348e325366620fe047edcc849e3c9424828599Peter Bray cd $top_of_mainline_tree
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal cd $top_of_9_1_tree
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal Alteratively, you can do this after building the kit, by giving
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal the kit .tar.gz file as an argument to altbuild.sh instad of
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco the CVS tag.
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray - If you can (= your system is similar enough to the one Tale is using),
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray check the header files for cruft by running the command
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray [ This step is quite imperfect and should probably be skipped
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray for now -- Tale ]
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray find lib -name '*.h' -print | xargs perl util/check-includes.pl
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Ensure that the JPNIC patch applies cleanly:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray If you don't have the "iconv" library, you need to get it from
cd348e325366620fe047edcc849e3c9424828599Peter Bray http://clisp.cons.org/~haible/packages-libiconv.html and install it.
cd348e325366620fe047edcc849e3c9424828599Peter Bray $ patch -p0 < contrib/idn/mdnkit/patch/bind9/patch.most > patch.out 2>&1
cd348e325366620fe047edcc849e3c9424828599Peter Bray All hunks should have applied successfully with no offset or fuzz.
cd348e325366620fe047edcc849e3c9424828599Peter Bray If all succeeded but some were offset or had fuzz, the patch will be
cd348e325366620fe047edcc849e3c9424828599Peter Bray regenerated at the end of this stage.
cd348e325366620fe047edcc849e3c9424828599Peter Bray [ Sample on netbsd ... ]
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray $ CFLAGS=-I/usr/local/include ./configure '--with-iconv=-L/usr/local/lib -liconv'
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray $ cd ../../.. ; : cd back to top level
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco $ ./configure
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray ... should cleanly compile
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray $ make distclean
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray $ mkdir -p /tmp/mdn/{lib,include}
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray $ ./configure --with-mdn=/tmp/mdn --with-iconv="-L/usr/local/lib -liconv"
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray $ LD_LIBRARY_PATH=/usr/local/lib:/tmp/mdn/lib:/usr/lib make
b34561d2c3d92fac37dbced05ba6a8738e3d20e9Lubos Kosco ... should cleanly compile
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray [ Some tests will be added to bin/tests/system to validate operation. ]
c83dfde6b364917fa8ed28142d509a7c29a4da68Vladimir Kotal Generate a fresh copy of the diffs:
cd348e325366620fe047edcc849e3c9424828599Peter Bray $ awk '/^\+\+\+ / {print $2}' $patchd/patch.most |
cd348e325366620fe047edcc849e3c9424828599Peter Bray while read i; do
cd348e325366620fe047edcc849e3c9424828599Peter Bray diff -u2 $i.orig $i
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray $ cvs diff -u2 configure > $patchd/patch.configure
cd348e325366620fe047edcc849e3c9424828599Peter Bray $ cvs ci -ko $patchd/patch.*
cd348e325366620fe047edcc849e3c9424828599Peter Bray - Add a marker line like " --- 9.0.0rc10 released ---"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray to the CHANGES file.
cd348e325366620fe047edcc849e3c9424828599Peter Bray - Tag the CVS source tree with the final tag, as in
cd348e325366620fe047edcc849e3c9424828599Peter Bray "cvs rtag v9_0_0rc1 bind9" (mainline) or
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray "cvs rtag -r v9_2 v9_2_0rc10 bind9" (release branch).
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Build the release kit. This procedure differs
cd348e325366620fe047edcc849e3c9424828599Peter Bray between the 9.0 release branch and later versions.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray On the 9.0 release branch,
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco cd <temporary directory>
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco cvs export -r v9_0_0rc10 bind9
d7c1415de39f4b07c85828f49cd1ee7a2a19eb9eLubos Kosco sh configure
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco On the 9.[1-2] release branch or mainline, use the
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray - Build bind9 from the kit on at least one machine
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray and test it. Run it as a caching name server.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray If you can, try resolving some IPv6 addresses and
3aa0947feb67d3e8292d84776638be98dd97fdc3Lubos Kosco doing queries over IPv6.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - If problems are found at this stage, fix them, move the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray release tag up using "rtag -F", and respin the kit.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - Sign the distribution files with the ISC signing PGP key
cd348e325366620fe047edcc849e3c9424828599Peter Bray and fix the permissions on the signature file:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray ver=9.2.0rc10
cd348e325366620fe047edcc849e3c9424828599Peter Bray pgp -sba bind-$ver.tar.gz -u 0x51BAB2ED
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal chmod 644 bind-$ver.tar.gz.asc
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal - Verify the PGP signature:
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal (Look for the words "Good signature" in the output.)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray - If there is a companion binary kit for NT, sign it and verify the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray pgp -sba BIND$ver.zip -u 0x51BAB2ED
cd348e325366620fe047edcc849e3c9424828599Peter Bray chmod 644 BIND$ver.zip.asc
4f3c0816485669143aa54f1c6461fcb47cf5bc5cVladimir Kotal - Prepare a release announcement based on the previous one.
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco - Copy the distribution and PGP signature files to the FTP site:
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind9/$ver"
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray - If there is a companion binary kit for NT, copy it, too:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind/contrib/ntbind-$ver"
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco isrv4.pa.vix.com:/udir/ftp/isc/bind/contrib/ntbind-$ver
d6ee3934a24d8ccc0e4bb478405d8e5f6a35825dLubos Kosco - Download using FTP (or a web browser) using the URLs in the release
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco announcement and verify the PGP signature again
b17cb0705d90907337b3528aa7b8ed1700806f26Vladimir Kotal - Ask webteam@nominum.com to publish the updated web pages
b17cb0705d90907337b3528aa7b8ed1700806f26Vladimir Kotal - When the web pages are up, announce the release on
8f8c3f4555e5aa3160f03f2e9c55ddbd3381357bLubos Kosco bind-announce@isc.org
8f8c3f4555e5aa3160f03f2e9c55ddbd3381357bLubos Kosco - Increment the version in the file "version"
d70dc22c6dce3f498251b0873638d1fea0e644a3Lubos Kosco - Resume doing pullups