annotate top/README-release @ 16464:2a3849cfe7b9

Tests for module 'modf-ieee'. * modules/modf-ieee-tests: New file. * tests/test-modf-ieee.c: New file.
author Bruno Haible <bruno@clisp.org>
date Sun, 26 Feb 2012 17:55:21 +0100
parents dea41e513071
children 2b67797f59e7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
1 Here are most of the steps we (maintainers) follow when making a release.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
2
16365
160fbb5c6a47 README-release: capitalize a word and split a line
Reuben Thomas <rrt@sc3d.org>
parents: 16323
diff changeset
3 * Start from a clean, up-to-date git directory:
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
4
15986
daf1a0e22ccb readme-release: improve safety of release prep instructions.
Gary V. Vaughan <gary@gnu.org>
parents: 15532
diff changeset
5 make -k maintainer-clean || { ./configure && make maintainer-clean; }
daf1a0e22ccb readme-release: improve safety of release prep instructions.
Gary V. Vaughan <gary@gnu.org>
parents: 15532
diff changeset
6 git checkout master
daf1a0e22ccb readme-release: improve safety of release prep instructions.
Gary V. Vaughan <gary@gnu.org>
parents: 15532
diff changeset
7 git pull origin master
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
8
16323
73e22dd042f1 doc: clarify README-release
Jim Meyering <meyering@redhat.com>
parents: 16172
diff changeset
9 * Ensure that the latest stable versions of autoconf, automake, etc.
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
10 are in your PATH. See the buildreq list in bootstrap.conf for
16323
73e22dd042f1 doc: clarify README-release
Jim Meyering <meyering@redhat.com>
parents: 16172
diff changeset
11 the complete list of tools.
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
12
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
13 * Ensure that you're on "master" with no uncommitted diffs.
16365
160fbb5c6a47 README-release: capitalize a word and split a line
Reuben Thomas <rrt@sc3d.org>
parents: 16323
diff changeset
14 This should produce no output:
160fbb5c6a47 README-release: capitalize a word and split a line
Reuben Thomas <rrt@sc3d.org>
parents: 16323
diff changeset
15
160fbb5c6a47 README-release: capitalize a word and split a line
Reuben Thomas <rrt@sc3d.org>
parents: 16323
diff changeset
16 git checkout master; git diff
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
17
16368
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
18 * Ensure that you've pushed all changes that belong in the release:
16375
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
19
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
20 git push origin master
16368
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
21
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
22 * Check that the NixOS/Hydra autobuilder is reporting all is well:
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
23
15986
daf1a0e22ccb readme-release: improve safety of release prep instructions.
Gary V. Vaughan <gary@gnu.org>
parents: 15532
diff changeset
24 http://hydra.nixos.org/jobset/gnu/@PACKAGE@-master
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
25
16375
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
26 * Run the following command to download any new translations:
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
27
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
28 ./bootstrap && ./configure
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
29
16375
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
30 * Pre-release testing: ensure that the following command succeeds:
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
31
dea41e513071 README-release: make it easier to execute commands
Reuben Thomas <rrt@sc3d.org>
parents: 16368
diff changeset
32 make check syntax-check distcheck
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
33
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
34 * Set the date, version number, and release type [stable/alpha/beta] on
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
35 line 3 of NEWS, commit that, and tag the release by running e.g.,
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
36
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
37 build-aux/do-release-commit-and-tag X.Y stable
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
38
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
39 * Run the following to create release tarballs. Your choice selects the
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
40 corresponding upload-to destination in the emitted gnupload command.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
41 The different destinations are specified in cfg.mk. See the definitions
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
42 of gnu_ftp_host-{alpha,beta,stable}.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
43
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
44 # "TYPE" must be stable, beta or alpha
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
45 make TYPE
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
46
15532
940a9cd08f44 doc: fix typo in README-release
Reuben Thomas <rrt@sc3d.org>
parents: 14679
diff changeset
47 * Test the tarball. Copy it to a few odd-ball systems and ensure that
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
48 it builds and passes all tests.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
49
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
50 * While that's happening, write the release announcement that you will
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
51 soon post. Start with the template, $HOME/announce-@PACKAGE@-X.Y
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
52 that was just created by that "make" command.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
53
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
54 Once all the builds and tests have passed,
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
55
16368
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
56 * Run the gnupload command that was suggested by your "make TYPE" run above.
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
57
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
58 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
59 download all tarball/signature pairs and use gpg --verify to ensure
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
60 that they're all valid.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
61
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
62 * Push the NEWS-updating changes and the new tag:
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
63
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
64 v=$(cat .prev-version)
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
65 git push origin master tag v$v
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
66
16368
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
67 * Announce it on Savannah first, so you can include the savannah.org
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
68 announcement link in the email message.
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
69
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
70 From here:
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
71 https://savannah.gnu.org/projects/@PACKAGE@/
16368
5b76eb148934 README-release: various improvements
Reuben Thomas <rrt@sc3d.org>
parents: 16365
diff changeset
72 click on "submit news", then write something like the following:
14679
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
73 (If there is no such button, then enable "News" for the project via
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
74 the Main -> "Select Features" menu item, or via this link:
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
75 https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=@PACKAGE@)
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
76
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
77 Subject: @PACKAGE@-X.Y released [stable]
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
78 +verbatim+
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
79 ...paste the announcement here...
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
80 -verbatim-
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
81
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
82 Then go here to approve it:
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
83 https://savannah.gnu.org/news/approve.php?group=@PACKAGE@
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
84
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
85 * Send the announcement email message.
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
86
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
87 * After each non-alpha release, update the on-line manual accessible via
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
88
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
89 http://www.gnu.org/software/@PACKAGE@/manual/
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
90
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
91 by running this:
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
92
2c310adf09e5 readme-release: new module with release instructions
Reuben Thomas <rrt@sc3d.org>
parents:
diff changeset
93 build-aux/gnu-web-doc-update