1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-01 12:20:26 +02:00

Reorganize the release checklists.

This commit is contained in:
Jim Blandy 1999-09-11 19:44:56 +00:00
parent 9185918452
commit 3f686b10a2

173
RELEASE
View file

@ -52,75 +52,104 @@ Julian Satchell <satchell@merry.dra.hmg.gb>:
dec-mips-ultrix dec-mips-ultrix
1) Check that the versions of aclocal, automake, autoconf, and autoheader
in your PATH match those given in README. Note that the `make Release Checklists ===================================================
dist' process always invokes these tools, even when all the
generated files are up to date. There are basically two phases to doing a release:
2) Verify that Guile builds and runs in your working directory. I
hope that we'll eventually have a test suite to make this more * "SPIFFING": Updating NEWS, README, INSTALL. Running tests. Getting
concrete, but for the moment, just make sure things seem sane. people to try builds on various machines. Getting everything
3) Make sure NEWS, INSTALL and the docs are up to date: straightened up.
a) Scan the ChangeLogs for user-visible changes, marked with an asterisk
at the left margin. * "PUNTING": Updating the version numbers. Tagging the sources. Asking
b) Update NEWS and the Texinfo documentation as appropriate. the FSF to put the disty on ftp.gnu.org. Posting announcements.
c) Remove the user-visible markers from the log entries once they're
documented. The "Spiffing" phase you might go through several times as you
d) Check for any [[incomplete]] sections of NEWS. discover problems. The "Punting" phase you do only once.
e) Fact-check INSTALL.
4) Scan output from `cvs diff' to find files that have changed a lot, but
do not have up-to-date copyright notices. Spiffing checklist:
5) Update the version numbers in GUILE-VERSION, and README. The Guile
version number should be of the form N.M for a major release, and * Do a `cvs update -A', to get rid of any sticky tags in your working
N.M.L for snapshots and beta releases; L should be even for beta directory.
releases, and odd for snapshots. * Check for files that have changed a lot, but do not have up-to-date
6) Make sure the downloading addressess and filenames are current. copyright notices. (It would be nice to have a script to do this...)
7) Set up README appropriately for the release; check name spellings * Make sure NEWS, INSTALL and the docs are up to date:
in THANKS, and reformat. + Scan the ChangeLogs for user-visible changes, marked with an asterisk
8) Choose new interface numbers for shared libraries. at the left margin.
9) Do a `cvs update -A', to get rid of any sticky tags. + Update NEWS and the Texinfo documentation as appropriate.
10) Rebuild all generated files in the source tree: + Remove the user-visible markers from the log entries once they're
a) Install the .m4 files where aclocal will find them. documented.
b) Run aclocal. + Check for any [[incomplete]] sections of NEWS.
c) Run automake. + Fact-check INSTALL.
d) Run autoconf. * Make sure the downloading addressess and filenames in README are
e) Run autoheader. current.
11) Commit all changes to the CVS repository. * Check that the versions of aclocal, automake, autoconf, and autoheader
12) Verify that the disty works, too: in your PATH match those given in README. Note that the `make
a) BEFORE doing 'make dist', configure the source tree for build dist' process always invokes these tools, even when all the
in the same tree with configuration option --with-threads. generated files are up to date.
Make sure that readline was enabled correctly. * Rebuild all generated files in the source tree:
If this is not done, there will be missing dependencies in two + Install the .m4 files where aclocal will find them.
Makefile.in. + Run aclocal.
b) Make a disty, using 'make dist'. + Run automake.
c) Unpack it somewhere else. + Run autoconf.
d) Remove automake and autoconf from your path, or turn off their + Run autoheader.
execute bits, or something. (Users should be able to build disty * Verify that Guile builds and runs in your working directory.
without installing those tools.) * Run the test suite, in guile-modules/test-suite.
e) Configure, make, and install. * Commit all changes to the CVS repository.
f) Test the installed version; don't forget to unset GUILE_LOAD_PATH. * Build a test distribution.
g) Test the example code in the doc directory. + BEFORE doing 'make dist', configure the source tree for build
h) Give the volunteer pre-release testers above a few days to run in the same tree with configuration option --with-threads.
the distribution on their systems (make the disty available to them Make sure that readline was enabled correctly.
via ftp). If this is not done, there will be missing dependencies in two
i) If you made any fixes, commit them, and start from a) again Makefile.in.
13) Add "Guile N.M released." entry to ChangeLog, and commit it. + Then do 'make dist'.
14) Tag the entire source tree with a tag of the form "release_N_M". * Give the test disty to various people to try. Here's what you should do:
15) Copy the tar file over to the GNU machines, and send mail to + Unset GUILE_LOAD_PATH.
ftp-upload@gnu.org, asking them to put it on prep. + Remove automake and autoconf from your path, or turn off their
16) Send an announcement message to gnu-announce@gnu.org. Put execute bits, or something. (Users must be able to build the
"Obtaining Guile" first, then a brief summary of the changes in disty without installing those tools.)
this release, then "Thanks," "About This Distribution," and + Configure, make, and install.
"Nightly Snapshots." If I remember correctly, the moderator will + Make sure LD_LIBRARY_PATH doesn't include anything unnecessary.
delay it until the tar file appears on prep. The announcement + Run the test suite on the installed version.
text should be mostly taken from Guile's README file. + You might try the example code in the doc directory.
17) Notify freshmeat.net, although they're probably watching anyway.
(They got the 1.3 release just fine.) I have no idea if Once you've got a disty that seems pretty solid:
www.bowerbird.com.au will be something anyone refers to, but Guile
does have an entry there. * Choose new interface numbers for shared libraries.
18) Tweak the version numbers in GUILE-VERSION, and README to indicate that * Update the version numbers in GUILE-VERSION and README. (There are
the sources are snapshot again. Snapshots should have version numbers many places in README that need updating!) The Guile version
of the form "N.M.L", where L is odd. number should have one of the following forms:
19) Start a new section of the NEWS file. N.M - a major release
20) Start a new THANKS file. N.M.L, where L is even - a minor release
21) Send mail to majordomo-owner@cygnus.com updating the message you get N.M.L, where L is odd - sources from CVS or nightly snapshot
when you ask majordomo for "info guile". * Reformat the names in THANKS.
* Do a `cvs update -A' of the whole tree, to look for any stray
uncommitted or accidental changes.
* Commit your changes.
* Make one last test distribution.
Punting checklist:
* Add "Guile N.M released." entry to the top-level ChangeLog, and commit it.
* Tag the entire source tree with a tag of the form "release_N_M"
or "release_N_M_L".
* Put the distribution up for FTP somewhere, and send mail to
ftp-upload@gnu.org, asking them to put it on prep.
* Send an announcement message to gnu-announce@gnu.org. Put a brief
summary of the changes in this release first, then "Obtaining
Guile", "Thanks", "About This Distribution," and "Nightly
Snapshots." If I remember correctly, the moderator will delay it
until the distribution appears on ftp.gnu.org. The announcement
text should be mostly taken from Guile's README file.
* Notify freshmeat.net, although they're probably watching anyway.
(They got the 1.3 release just fine.) I have no idea if
www.bowerbird.com.au will be something anyone refers to, but Guile
does have an entry there.
* Tweak the version numbers in GUILE-VERSION, and README to indicate
that the sources are a snapshot again. Snapshots should have
version numbers of the form "N.M.L", where L is odd.
* Start a new section of the NEWS file.
* Start a new THANKS file.
* Send mail to majordomo-owner@cygnus.com updating the message you
get when you ask majordomo for "info guile".