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 HACKING for the complete list.
  11
  12 * Ensure that you're on "master" with no uncommitted diffs.
  13   This should produce no output: git checkout master; git diff
  14
  15 * Make sure your local gnulib directory is up to date.
  16
  17 * Run bootstrap, (assuming your local copy of gnulib is in /gnulib):
  18   ./bootstrap --gnulib-srcdir=/gnulib
  19
  20 FIXME: enable excluded programs like arch? to get their manual pages?
  21
  22 * Pre-release testing:
  23   On at least one SELinux-enabled (enforcing) and one non-SELinux system,
  24     run all tests, both root-only and regular.
  25   Run *all* non-root tests, including expensive and very expensive ones i.e.,
  26     run this: make check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
  27
  28   Run the root-only tests:
  29   sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k check-root
  30
  31 * Run "make distcheck"
  32
  33 * Manually set the date, version number, and [stable/alpha/beta] on
  34   line 3 of NEWS, then do this:
  35
  36     v=7.1
  37     git commit -F <(printf 'version '$v'\n\n* NEWS: Record release date.\n') -a
  38     git tag -s -m "coreutils $v" v$v HEAD
  39
  40 * Run the following to create release tarballs.  Your choice selects the
  41   corresponding upload-to destination in the emitted gnupload command.
  42
  43     # "TYPE" must be major, beta or alpha
  44     make TYPE
  45
  46 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  47   it builds and passes all tests.
  48
  49 * While that's happening, write the release announcement that you will
  50   soon post.
  51
  52 Once all the builds and tests have passed,
  53
  54 * Run the gnupload command suggested by your "XZ_OPT=-9e make major" run above.
  55
  56 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  57   download all tarball/signature pairs and use gpg --verify to ensure
  58   that they're all valid.
  59
  60 * Push the new tag:
  61   git push origin tag v<JUST_RELEASED_VERSION_NUMBER>
  62
  63 * Send the gpg-signed announcement mail, e.g.,
  64     To: info-gnu@gnu.org, coreutils-announce@gnu.org
  65     Cc: coordinator@translationproject.org, bug-coreutils@gnu.org
  66     Subject: coreutils-7.1 released [stable]
  67
  68 * Approve the announcement here:
  69   http://lists.gnu.org/mailman/admindb/coreutils-announce
  70
  71 * Announce it on Savannah, too:
  72   From here:
  73     https://savannah.gnu.org/projects/coreutils/
  74   click on the "submit news", then write something like the following:
  75
  76     The announcement is here:
  77       http://article.gmane.org/gmane.comp.gnu.core-utils.announce/48
  78
  79   Then go here to approve it:
  80     https://savannah.gnu.org/news/approve.php?group=coreutils
  81
  82 * For non-alpha releases, update the on-line manual at
  83
  84     http://www.gnu.org/software/coreutils/manual/
  85
  86   Run `make web-manual', then copy the contents of doc/manual
  87   into a CVS checkout of the coreutils manual repository.
  88   Also edit coreutils.html (FIXME? why?) before doing a CVS commit.
  89
  90     CVS_RSH=ssh \
  91     cvs -d:ext:$USER@cvs.savannah.gnu.org:/web/coreutils co coreutils
  92
  93   Be sure to "cvs add -ko" any files that "cvs status" marks with "?".
  94   That is necessary whenever a new texinfo node is added.  Each becomes
  95   a new file in html_node that must then be "cvs add"ed.