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