aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart PoetteringCopyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart PoetteringCopyright (C) 2000-2003 Internet Software Consortium.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart PoetteringSee COPYRIGHT in the source root or http://isc.org/copyright.html for terms.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering$Id: release,v 1.60 2004/03/18 02:57:55 marka Exp $

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart PoetteringPreparing a bind9 release

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart PoetteringHere's a rough outline of the steps to follow in preparing a new bind9

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poetteringrelease.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Update the README file

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Send the new README file to webteam@nominum.com at least 48

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering hours prior to the planned release and ask them to prepare

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering the web pages for the new version. If there have been only

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering minor changes, send context diffs relative to the previous

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering release instead.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Do a "cvs update" to check that all changes have been committed.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Verify that the file "version" contains the correct version

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering number (it should have been incremented after the

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering previous release)

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - If building from a release branch, check that any important

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering bug fixes made on the mainline since the last release have

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering been pulled up. You can do this by comparing the CHANGES

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering files using the util/check-pullups.pl script. For example,

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering running the script from a mainline tree:

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering perl util/check-pullups.pl CHANGES ../9.2/CHANGES ../9.2/EXCLUDED

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering This will list all bug fixes on the mainline that are not

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering on the 9.2 release branch.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Before creating a new release branch, update the lib/*/api files

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering as needed. See the libtool info file for information about what

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering the various numbers mean.

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering - Check that http://status.isc.org/bind9/bind9.html

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering shows a clean build and test status for all supported

98f91566cc7d43c6b86a711fa1d196ed5876b2f3Lennart Poettering systems and that the tests are actually being run on the

98f91566cc7d43c6b86a711fa1d196ed5876b2f3Lennart Poettering version being released (the version can be found in the

98f91566cc7d43c6b86a711fa1d196ed5876b2f3Lennart Poettering page behind the "Source tar build" link).

98f91566cc7d43c6b86a711fa1d196ed5876b2f3Lennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering - Check that running "make all_tests" in bin/tests does not

0095c45415ad24338342369d76d5635088294eaeLennart Poettering produce compile errors.

0095c45415ad24338342369d76d5635088294eaeLennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering - Regenerate the documentation by running "make man" (mainline/9.2)

0095c45415ad24338342369d76d5635088294eaeLennart Poettering or by running genhtml.sh in doc/arm (9.1 release branch)

0095c45415ad24338342369d76d5635088294eaeLennart Poettering and commit it. Note that not all machines have the

0095c45415ad24338342369d76d5635088294eaeLennart Poettering necessary XML tools, but at least trebuchet, cuba,

0095c45415ad24338342369d76d5635088294eaeLennart Poettering and Scanner's machine do. Commit any files that were

0095c45415ad24338342369d76d5635088294eaeLennart Poettering regenerated.

0095c45415ad24338342369d76d5635088294eaeLennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering - Verify that the documents in doc/misc are up-to-date.

0095c45415ad24338342369d76d5635088294eaeLennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering - Update the copyrights. According to tale:

0095c45415ad24338342369d76d5635088294eaeLennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering Go to the root of the source tree.

0095c45415ad24338342369d76d5635088294eaeLennart Poettering The scripts need to be run from there; they reference the util

0095c45415ad24338342369d76d5635088294eaeLennart Poettering subdirectory internally.

0095c45415ad24338342369d76d5635088294eaeLennart Poettering

0095c45415ad24338342369d76d5635088294eaeLennart Poettering $ make distclean

0095c45415ad24338342369d76d5635088294eaeLennart Poettering ... [I prefer to check out a fresh source tree --gson]

0095c45415ad24338342369d76d5635088294eaeLennart Poettering $ perl util/merge_copyrights

0095c45415ad24338342369d76d5635088294eaeLennart Poettering $ diff util/copyrights util/newcopyrights

0095c45415ad24338342369d76d5635088294eaeLennart Poettering ... examine output, particularly any files with the "?" type, and

0095c45415ad24338342369d76d5635088294eaeLennart Poettering ... then edit util/newcopyrights if necessary

0095c45415ad24338342369d76d5635088294eaeLennart Poettering $ mv util/newcopyrights util/copyrights

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering $ cvs ci -m'merge_copyrights' util/copyrights

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering $ perl util/update_copyrights < util/copyrights

aacf3b483b70b9a9ff16217f6376d143cbfe4636Lennart Poettering $ cvs diff

... examine output, edit as necessary. mail me about anything that

... the script should have been able to do itself. :-)

$ cvs ci -m'update_copyrights'

- Announce a CVS freeze if doing an alpha or beta release from

the mainline, or stop doing pullups if building from a release branch.

- Run util/altbuild.sh. This is to make sure that

builds using libtool, separate source/object directories, and other

obscure build options work. This script may need some hacking if run

on anything other than NetBSD. Save the output (it's big) and look

for error and warning messages.

cd $top_of_mainline_tree

sh util/altbuild.sh v9_0

or

cd $top_of_9_1_tree

sh util/altbuild.sh v9_1

Alteratively, you can do this after building the kit, by giving

the kit .tar.gz file as an argument to altbuild.sh instad of

the CVS tag.

- If you can (= your system is similar enough to the one Tale is using),

check the header files for cruft by running the command

[ This step is quite imperfect and should probably be skipped

for now -- Tale ]

find lib -name '*.h' -print | xargs perl util/check-includes.pl

- Ensure that the JPNIC patch applies cleanly:

If you don't have the "iconv" library, you need to get it from

http://clisp.cons.org/~haible/packages-libiconv.html and install it.

If you're reading this part of these instructions in order to generate

a version of the patch for a new release, you'll need to pick a

version of the patch from some prior release to use as a starting

point. In general, the patch corresponding to the most recent

prior release will be the best starting point.

$ patch -p0 < contrib/idn/idnkit-1.0-src/patch/bind9/bind-9.x.y-patch \

> patch.out 2>&1

$ egrep Hunk patch.out

All hunks should have applied successfully with no offset or fuzz.

If all succeeded but some were offset or had fuzz, the patch will be

regenerated at the end of this stage.

Note that two of the files which the patch attempts to update

(configure and config.h.in) are generated automatically. When

generating a new patch, the old version of the patch may not apply

correctly to these files, but that's ok so long as the patch does

apply correctly to the source files from which these files are

generated. The steps below will regenerate these files.

$ cd contrib/idn/idnkit-1.0-src

[ Sample on netbsd ... ]

$ CFLAGS=-I/usr/local/include ./configure '--with-iconv=-L/usr/local/lib -liconv'

[ Sample on freebsd -- formerly used giconv, now uses iconv ]

./configure --with-iconv-include=/usr/local/include \

'--with-iconv=-L/usr/local/lib -liconv'

$ make

$ cd ../../.. ; : cd back to top level

$ autoheader ; : regenerate config.h.in

$ autoconf ; : regenerate configure

$ ./configure

$ make

... should cleanly compile

$ make distclean

$ rm -rf /tmp/idn

$ mkdir -p /tmp/idn/lib /tmp/idn/include

$ idn=contrib/idn/idnkit-1.0-src

$ cp $idn/lib/.libs/libidnkit.so* /tmp/idn/lib

$ cp -r $idn/include/mdn $idn/include/idn /tmp/idn/include

$ ./configure --with-idn=/tmp/idn --with-iconv="-L/usr/local/lib -liconv"

$ LD_LIBRARY_PATH=/usr/local/lib:/tmp/idn/lib:/usr/lib make

... should cleanly compile

[ Some tests will be added to bin/tests/system to validate operation. ]

Generate a fresh copy of the diffs:

$ patchd=$idn/patch/bind9

$ old_patch=bind-9.x.y-patch

$ new_patch=bind-9.x.z-patch

$ files=`awk '/^Index:/ && NF == 2 {print $2}' $patchd/$old_patch`

$ missing=`cvs log -R $files 2>&1 >/dev/null | \

awk '/^cvs log: nothing known about/ {print $6}'`

$ for i in $missing; \

do echo Index: $i; diff -u /dev/null $i; done >$patchd/$new_patch

$ cvs -f diff -U 2 -N $files >>$patchd/$new_patch

[ Add comment at head of new patch file ]

$ cvs add -ko $patchd/$new_patch

$ cvs ci $patchd/$new_patch

- Add a marker line like " --- 9.0.0rc10 released ---"

to the CHANGES file.

- Tag the CVS source tree with the final tag, as in

"cvs rtag v9_0_0rc1 bind9" (mainline) or

"cvs rtag -r v9_2 v9_2_0rc10 bind9" (release branch).

- Build the release kit. This procedure differs

between the 9.0 release branch and later versions.

On the 9.0 release branch,

cd <temporary directory>

cvs export -r v9_0_0rc10 bind9

cd bind9

sh configure

make kit

On the 9.[1-2] release branch or mainline, use the

"util/kit.sh" script.

- Build bind9 from the kit on ns-ext (phred)

and ns-int (rc), install it, and let it run for

a day keeping an eye on it for any problems.

ssh phred.isc.org

ver=9.2.0

scp rc.isc.org:bind-$ver.tar.gz .

gunzip <bind-$ver.tar.gz | tar xfv -

cd bind-$ver

sh configure

make

su

make install

ps -elf | grep named

# kill both the keep-running script and named itself

/var/named/keep-running ns-ext &

ssh rc

ver=9.2.0

gunzip <bind-$ver.tar.gz | tar xfv -

cd bind-$ver

sh configure

make

su

make install

mv /usr/local/sbin/named /usr/local/sbin/named9

ps -elf | grep named

# kill both keep-running scripts and both named9:s

/var/named/keep-running9 rc-res1 &

/var/named/keep-running9 ns-int &

- If you can, try resolving some IPv6 addresses and

doing queries over IPv6.

- If problems are found at this stage, fix them, move the

release tag up using "rtag -F", and respin the kit.

- Sign the distribution files with the ISC signing PGP key

and fix the permissions on the signature file:

ver=9.2.0

pgp -sba bind-$ver.tar.gz -u 0x51BAB2ED

chmod 644 bind-$ver.tar.gz.asc

- Verify the PGP signature:

pgp bind-$ver.tar.gz.asc bind-$ver.tar.gz

(Look for the words "Good signature" in the output.)

- If there is a companion binary kit for NT, sign it and verify the

signature:

scp rc.isc.org:/udir/mayer/BIND$ver.zip .

pgp -sba BIND$ver.zip -u 0x51BAB2ED

chmod 644 BIND$ver.zip.asc

pgp BIND$ver.zip.asc BIND$ver.zip

- Prepare a release announcement based on the previous one.

- Copy the distribution and PGP signature files to the FTP site:

ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind9/$ver"

scp bind-$ver.tar.gz bind-$ver.tar.gz.asc \

isrv4.pa.vix.com:/udir/ftp/isc/bind9/$ver

- If there is a companion binary kit for NT, copy it, too:

ssh -n isrv4.pa.vix.com "mkdir /udir/ftp/isc/bind/contrib/ntbind-$ver"

scp BIND$ver.zip BIND$ver.zip.asc \

isrv4.pa.vix.com:/udir/ftp/isc/bind/contrib/ntbind-$ver

- Download using FTP (or a web browser) using the URLs in the release

announcement and verify the PGP signature again

- Ask webteam@nominum.com to publish the updated web pages

- When the web pages are up, announce the release on

bind-announce@isc.org

- Increment the version in the file "version"

- Resume doing pullups