release revision 8d10c10ec928e4680a0c74280287a17a580120a7
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncCopyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncCopyright (C) 2000-2003 Internet Software Consortium.
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsyncSee COPYRIGHT in the source root or http://isc.org/copyright.html for terms.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync$Id: release,v 1.64 2005/09/09 14:11:37 marka Exp $
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncPreparing a bind9 release
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncHere's a rough outline of the steps to follow in preparing a new bind9
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Update the README file
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Send the new README file to webteam@nominum.com at least 48
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hours prior to the planned release and ask them to prepare
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the web pages for the new version. If there have been only
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync minor changes, send context diffs relative to the previous
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync release instead.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Do a "cvs update" to check that all changes have been committed.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Verify that the file "version" contains the correct version
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync number (it should have been incremented after the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync previous release)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If building from a release branch, check that any important
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync bug fixes made on the mainline since the last release have
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync been pulled up. You can do this by comparing the CHANGES
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync files using the util/check-pullups.pl script. For example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync running the script from a mainline tree:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync perl util/check-pullups.pl CHANGES ../9.2/CHANGES ../9.2/EXCLUDED
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This will list all bug fixes on the mainline that are not
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on the 9.2 release branch.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Before creating a new release branch, update the lib/*/api files
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync as needed. See the libtool info file for information about what
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the various numbers mean.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Check that http://status.isc.org/bind9/bind9.html
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync shows a clean build and test status for all supported
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync systems and that the tests are actually being run on the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync version being released (the version can be found in the
63636e131aa8b7d2aa48f3f928102a02c0f454bcvboxsync page behind the "Source tar build" link).
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Check that running "make all_tests" in bin/tests does not
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync produce compile errors.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Regenerate the documentation by running "make man" (mainline/9.2)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync or by running genhtml.sh in doc/arm (9.1 release branch)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and commit it. Note that not all machines have the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync necessary XML tools, but at least trebuchet, cuba,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and Scanner's machine do. Commit any files that were
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync regenerated.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Verify that the documents in doc/misc are up-to-date.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Update the copyrights. According to tale:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Go to the root of the source tree.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync The scripts need to be run from there; they reference the util
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync subdirectory internally.
22e5e79c3462b52f8da631a7b92f82ed03550d52vboxsync $ make distclean
22e5e79c3462b52f8da631a7b92f82ed03550d52vboxsync ... [I prefer to check out a fresh source tree --gson]
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync ... examine output, particularly any files with the "?" type, and
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync ... then edit util/newcopyrights if necessary
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs ci -m'merge_copyrights' util/copyrights
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ... examine output, edit as necessary. mail me about anything that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ... the script should have been able to do itself. :-)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs ci -m'update_copyrights'
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Announce a CVS freeze if doing an alpha or beta release from
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the mainline, or stop doing pullups if building from a release branch.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Run util/altbuild.sh. This is to make sure that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync builds using libtool, separate source/object directories, and other
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync obscure build options work. This script may need some hacking if run
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on anything other than NetBSD. Save the output (it's big) and look
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for error and warning messages.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cd $top_of_mainline_tree
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cd $top_of_9_1_tree
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Alteratively, you can do this after building the kit, by giving
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the kit .tar.gz file as an argument to altbuild.sh instad of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the CVS tag.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If you can (= your system is similar enough to the one Tale is using),
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync check the header files for cruft by running the command
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [ This step is quite imperfect and should probably be skipped
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for now -- Tale ]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync find lib -name '*.h' -print | xargs perl util/check-includes.pl
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Ensure that the JPNIC patch applies cleanly:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync If you don't have the "iconv" library, you need to get it from
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync http://clisp.cons.org/~haible/packages-libiconv.html and install it.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync If you're reading this part of these instructions in order to generate
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync a version of the patch for a new release, you'll need to pick a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync version of the patch from some prior release to use as a starting
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync point. In general, the patch corresponding to the most recent
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync prior release will be the best starting point.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ patch -p0 < contrib/idn/idnkit-1.0-src/patch/bind9/bind-9.x.y-patch \
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync All hunks should have applied successfully with no offset or fuzz.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync If all succeeded but some were offset or had fuzz, the patch will be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync regenerated at the end of this stage.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Note that two of the files which the patch attempts to update
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (configure and config.h.in) are generated automatically. When
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync generating a new patch, the old version of the patch may not apply
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync correctly to these files, but that's ok so long as the patch does
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync apply correctly to the source files from which these files are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync generated. The steps below will regenerate these files.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [ Sample on netbsd ... ]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ CFLAGS=-I/usr/local/include ./configure '--with-iconv=-L/usr/local/lib -liconv'
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [ Sample on freebsd -- formerly used giconv, now uses iconv ]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ./configure --with-iconv-include=/usr/local/include \
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync '--with-iconv=-L/usr/local/lib -liconv'
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cd ../../.. ; : cd back to top level
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ autoheader ; : regenerate config.h.in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ autoconf ; : regenerate configure
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ ./configure
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ... should cleanly compile
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ make distclean
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cp -r $idn/include/mdn $idn/include/idn /tmp/idn/include
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ ./configure --with-idn=/tmp/idn --with-iconv="-L/usr/local/lib -liconv"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ LD_LIBRARY_PATH=/usr/local/lib:/tmp/idn/lib:/usr/lib make
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ... should cleanly compile
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [ Some tests will be added to bin/tests/system to validate operation. ]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Generate a fresh copy of the diffs:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ files=`awk '/^Index:/ && NF == 2 {print $2}' $patchd/$old_patch`
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ missing=`cvs log -R $files 2>&1 >/dev/null | \
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync awk '/^cvs (log|server): nothing known about/ {print $6}'`
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ sed '/^Index:/,$d' $patchd/$old_patch > $patchd/$new_patch
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ for i in $missing; \
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync do echo Index: $i; diff -u /dev/null $i; done >> $patchd/$new_patch
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs -f diff -U 2 -N $files >> $patchd/$new_patch
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs add -ko $patchd/$new_patch
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs ci $patchd/$new_patch
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ cvs update -C
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync $ make distclean
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Add a marker line like " --- 9.0.0rc10 released ---"
447cbf113f44132911fc13dc33cb26603759b82evboxsync to the CHANGES file.
447cbf113f44132911fc13dc33cb26603759b82evboxsync - Tag the CVS source tree with the final tag, as in
447cbf113f44132911fc13dc33cb26603759b82evboxsync "cvs rtag v9_0_0rc1 bind9" (mainline) or
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync "cvs rtag -r v9_2 v9_2_0rc10 bind9" (release branch).
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync - Build the release kit. This procedure differs
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync between the 9.0 release branch and later versions.
447cbf113f44132911fc13dc33cb26603759b82evboxsync On the 9.0 release branch,
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync cd <temporary directory>
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync cvs export -r v9_0_0rc10 bind9
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync sh configure
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync On the 9.[1-2] release branch or mainline, use the
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync - Build bind9 from the kit on ns-ext (phred)
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync and ns-int (rc), install it, and let it run for
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync a day keeping an eye on it for any problems.
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync gunzip <bind-$ver.tar.gz | tar xfv -
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync cd bind-$ver
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync sh configure
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync make install
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync ps -elf | grep named
daac39eba667f9e64b03ef08bb5cd7c965cd72c2vboxsync # kill both the keep-running script and named itself
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync gunzip <bind-$ver.tar.gz | tar xfv -
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cd bind-$ver
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync sh configure
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync make install
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ps -elf | grep named
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync # kill both keep-running scripts and both named9:s
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If you can, try resolving some IPv6 addresses and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync doing queries over IPv6.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If problems are found at this stage, fix them, move the
53267393b2631d5c5dbdc5f6996b5feebfd9b12cvboxsync release tag up using "rtag -F", and respin the kit.
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync - Sign the distribution files with the ISC signing PGP key
dad6cdf976d1a75918d0d66731bb1b916a29b1fdvboxsync and fix the permissions on the signature file:
53267393b2631d5c5dbdc5f6996b5feebfd9b12cvboxsync pgp -sba bind-$ver.tar.gz -u 0x51BAB2ED
53267393b2631d5c5dbdc5f6996b5feebfd9b12cvboxsync chmod 644 bind-$ver.tar.gz.asc
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Verify the PGP signature:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (Look for the words "Good signature" in the output.)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If there is a companion binary kit for NT, sign it and verify the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pgp -sba BIND$ver.zip -u 0x51BAB2ED
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync chmod 644 BIND$ver.zip.asc
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Prepare a release announcement based on the previous one.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Copy the distribution and PGP signature files to the FTP site:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind9/$ver"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - If there is a companion binary kit for NT, copy it, too:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind/contrib/ntbind-$ver"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync isrv4.pa.vix.com:/udir/ftp/isc/bind/contrib/ntbind-$ver
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Download using FTP (or a web browser) using the URLs in the release
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync announcement and verify the PGP signature again
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Ask webteam@nominum.com to publish the updated web pages
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - When the web pages are up, announce the release on
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync bind-announce@isc.org
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Increment the version in the file "version"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync - Resume doing pullups