try again
[debian/gzip] / README-release
1 Here are most of the steps we (maintainers) follow when making a release.
2
3 * Start from a clean, up-to-date git directory on "master":
4
5     make -k maintainer-clean || { ./configure && make maintainer-clean; }
6     git checkout master
7     git pull origin master
8
9 * Ensure that the latest stable versions of autoconf, automake, etc.
10   are in your PATH.  See the buildreq list in bootstrap.conf for
11   the complete list of tools.
12
13 * Ensure that you have no uncommitted diffs.  This should produce no
14   output:
15
16     git diff
17
18 * Ensure that you've pushed all changes that belong in the release:
19
20     git push origin master
21
22 * Check that the NixOS/Hydra autobuilder is reporting all is well:
23
24     http://hydra.nixos.org/jobset/gnu/gzip-master
25
26 * Run the following command to download any new translations:
27
28     ./bootstrap && ./configure
29
30 * Pre-release testing: ensure that the following command succeeds:
31
32     make check syntax-check distcheck
33
34 * From top_srcdir, run:
35
36     build-aux/do-release-commit-and-tag X.Y stable
37
38   in order to (i) set the date, version number, and release type
39   [stable/alpha/beta] on line 3 of NEWS, (ii) commit that, and (iii) tag the
40   release.  See --help if you need options such as:
41
42     build-aux/do-release-commit-and-tag --branch=maint -C _build X.Y.Z stable
43
44 * Run the following to create release tarballs.  Your choice selects the
45   corresponding upload-to destination in the emitted gnupload command.
46   The different destinations are specified in cfg.mk.  See the definitions
47   of gnu_ftp_host-{alpha,beta,stable}.
48
49     # "TYPE" must be stable, beta or alpha
50     make TYPE
51
52 * Test the tarball.  Copy it to a few odd-ball systems and ensure that
53   it builds and passes all tests.
54
55 * While that's happening, write the release announcement that you will
56   soon post.  Start with the template, $HOME/announce-gzip-X.Y
57   that was just created by that "make" command.
58
59 Once all the builds and tests have passed,
60
61 * Run the gnupload command that was suggested by your "make TYPE" run above.
62
63 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
64   download all tarball/signature pairs and use gpg --verify to ensure
65   that they're all valid.
66
67 * Push the NEWS-updating changes and the new tag:
68
69     v=$(cat .prev-version)
70     git push origin master tag v$v
71
72 * Announce it on Savannah first, so you can include the savannah.org
73   announcement link in the email message.
74
75   From here:
76     https://savannah.gnu.org/projects/gzip/
77   click on "submit news", then write something like the following:
78   (If there is no such button, then enable "News" for the project via
79    the Main -> "Select Features" menu item, or via this link:
80    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=gzip)
81
82     Subject: gzip-X.Y released [stable]
83     +verbatim+
84     ...paste the announcement here...
85     -verbatim-
86
87   Then go here to approve it:
88     https://savannah.gnu.org/news/approve.php?group=gzip
89
90 * Send the announcement email message.
91
92 * After each non-alpha release, update the on-line manual accessible via
93
94     http://www.gnu.org/software/gzip/manual/
95
96   by running this from top_srcdir:
97
98     build-aux/gnu-web-doc-update
99
100   possibly with "-C <BUILDDIR>"