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