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