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 * Check for new file system types by running the following command on
  28   a system with the most recent kernel possible (e.g., Fedora rawhide):
  29
  30     make -C src fs-magic-compare
  31
  32   If it finds a new file system magic number, add it to src/stat.c.
  33   If it is a remote file system, add the new S_MAGIC_* name you created
  34   in stat.c to the list of remote file system types in src/tail.c's
  35   fremote function.
  36
  37 * Pre-release testing:
  38
  39   Run the following on at least one SELinux-enabled (enforcing) and
  40   one non-SELinux system:
  41
  42     n=$(( ($(nproc) + 1) / 2 ))
  43     sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k -j$(nproc) check-root\
  44       && make distcheck \
  45       && make -j$n check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
  46
  47   If testing on systems with a non standard default shell, spurious failures
  48   may occur.  Often there are other shells available, and you can select
  49   those by using for example, SHELL=bash in the commands above.
  50
  51   Note that the use of -j$n tells make to use approximately half of the
  52   available processing units.  If you use -jN, for larger N, some of the
  53   expensive tests are likely to interfere with concurrent performance-measuring
  54   or timing-sensitive tests, resulting in spurious failures.
  55
  56   If "make distcheck" doesn't run "make syntax-check" for you, then run
  57   it manually:
  58
  59     make syntax-check
  60
  61 * Set the date, version number, and release type [stable/alpha/beta] on
  62   line 3 of NEWS, commit that, and tag the release by running e.g.,
  63
  64     build-aux/do-release-commit-and-tag X.Y stable
  65
  66 * Run the following to create release tarballs.  Your choice selects the
  67   corresponding upload-to destination in the emitted gnupload command.
  68   The different destinations are specified in cfg.mk.  See the definitions
  69   of gnu_ftp_host-{alpha,beta,stable}.
  70
  71     # "TYPE" must be stable, beta or alpha
  72     make TYPE
  73
  74 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  75   it builds and passes all tests.
  76
  77 * While that's happening, write the release announcement that you will
  78   soon post.  Start with the template, $HOME/announce-coreutils-X.Y
  79   that was just created by that "make" command.
  80
  81 Once all the builds and tests have passed,
  82
  83 * Run the gnupload command that was suggested by your "make stable" run above.
  84
  85 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  86   download all tarball/signature pairs and use gpg --verify to ensure
  87   that they're all valid.
  88
  89 * Push the NEWS-updating changes and the new tag:
  90
  91     v=$(cat .prev-version)
  92     git push origin master tag v$v
  93
  94 * Announce it on Savannah first, so you can include the preferable
  95   savannah.org announcement link in the email message.
  96
  97   From here:
  98     https://savannah.gnu.org/projects/coreutils/
  99   click on the "submit news", then write something like the following:
 100   (If there is no such button, then enable "News" for the project via
 101    the Main -> "Select Features" menu item, or via this link:
 102    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=coreutils)
 103
 104     Subject: coreutils-X.Y released [stable]
 105     +verbatim+
 106     ...paste the announcement here...
 107     -verbatim-
 108
 109   Then go here to approve it:
 110     https://savannah.gnu.org/news/approve.php?group=coreutils
 111
 112 * Send the announcement email message.
 113
 114 * Approve the announcement here:
 115   http://lists.gnu.org/mailman/admindb/coreutils-announce
 116
 117 * After each non-alpha release, update the on-line manual accessible via
 118
 119     http://www.gnu.org/software/coreutils/manual/
 120
 121   by running this:
 122
 123     build-aux/gnu-web-doc-update