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.
   4
   5     git checkout master; git pull
   6
   7 * Run ./configure && make maintainer-clean
   8
   9 * Ensure that the desired versions of autoconf, automake, bison, etc.
  10   are in your PATH.  See the buildreq list in bootstrap.conf for
  11   the complete list.
  12
  13 * Ensure that you're on "master" with no uncommitted diffs.
  14   This should produce no output: git checkout master; git diff
  15
  16 * Ensure that you've pushed all changes that belong in the release
  17   and that the NixOS/Hydra autobuilder is reporting all is well:
  18
  19       http://hydra.nixos.org/jobset/gnu/coreutils-master
  20
  21 * Run bootstrap one last time.  This downloads any new translations:
  22
  23     ./bootstrap
  24
  25 FIXME: enable excluded programs like arch? to get their manual pages?
  26
  27 * Pre-release testing:
  28
  29   Run the following on at least one SELinux-enabled (enforcing) and
  30   one non-SELinux system:
  31
  32     n=$(( ($(nproc) + 1) / 2 ))
  33     sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k -j$(nproc) check-root\
  34       && make distcheck \
  35       && make -j$n check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
  36
  37   If testing on systems with a non standard default shell, spurious failures
  38   may occur.  Often there are other shells available, and you can select
  39   those by using for example, SHELL=bash in the commands above.
  40
  41   Note that the use of -j$n tells make to use approximately half of the
  42   available processing units.  If you use -jN, for larger N, some of the
  43   expensive tests are likely to interfere with concurrent performance-measuring
  44   or timing-sensitive tests, resulting in spurious failures.
  45
  46   If "make distcheck" doesn't run "make syntax-check" for you, then run
  47   it manually:
  48
  49     make syntax-check
  50
  51 * Set the date, version number, and release type [stable/alpha/beta] on
  52   line 3 of NEWS, commit that, and tag the release by running e.g.,
  53
  54     build-aux/do-release-commit-and-tag X.Y stable
  55
  56 * Run the following to create release tarballs.  Your choice selects the
  57   corresponding upload-to destination in the emitted gnupload command.
  58   The different destinations are specified in cfg.mk.  See the definitions
  59   of gnu_ftp_host-{alpha,beta,stable}.
  60
  61     # "TYPE" must be stable, beta or alpha
  62     make TYPE
  63
  64 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  65   it builds and passes all tests.
  66
  67 * While that's happening, write the release announcement that you will
  68   soon post.  Start with the template, $HOME/announce-coreutils-X.Y
  69   that was just created by that "make" command.
  70
  71 Once all the builds and tests have passed,
  72
  73 * Run the gnupload command that was suggested by your "make stable" run above.
  74
  75 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  76   download all tarball/signature pairs and use gpg --verify to ensure
  77   that they're all valid.
  78
  79 * Push the NEWS-updating changes and the new tag:
  80
  81     v=$(cat .prev-version)
  82     git push origin master tag v$v
  83
  84 * Announce it on Savannah first, so you can include the preferable
  85   savannah.org announcement link in the email message.
  86
  87   From here:
  88     https://savannah.gnu.org/projects/coreutils/
  89   click on the "submit news", then write something like the following:
  90   (If there is no such button, then enable "News" for the project via
  91    the Main -> "Select Features" menu item, or via this link:
  92    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=coreutils)
  93
  94     Subject: coreutils-X.Y released [stable]
  95     +verbatim+
  96     ...paste the announcement here...
  97     -verbatim-
  98
  99   Then go here to approve it:
 100     https://savannah.gnu.org/news/approve.php?group=coreutils
 101
 102 * Send the announcement email message.
 103
 104 * Approve the announcement here:
 105   http://lists.gnu.org/mailman/admindb/coreutils-announce
 106
 107 * After each non-alpha release, update the on-line manual accessible via
 108
 109     http://www.gnu.org/software/coreutils/manual/
 110
 111   by running this:
 112
 113     build-aux/gnu-web-doc-update