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