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 -j1 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 e.g.,:
  35
  36     v=7.3
  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   The different destinations are specified in cfg.mk.  See the definitions
  43   of gnu_ftp_host-{alpha,beta,major}.
  44
  45     # "TYPE" must be major, beta or alpha
  46     make TYPE
  47
  48 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  49   it builds and passes all tests.
  50
  51 * While that's happening, write the release announcement that you will
  52   soon post.
  53
  54 Once all the builds and tests have passed,
  55
  56 * Run the gnupload command that was suggested by your "make major" run above.
  57
  58 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  59   download all tarball/signature pairs and use gpg --verify to ensure
  60   that they're all valid.
  61
  62 * Push the new tag:
  63   git push origin tag v<JUST_RELEASED_VERSION_NUMBER>
  64
  65 * Send the gpg-signed announcement mail, e.g.,
  66     To: info-gnu@gnu.org, coreutils-announce@gnu.org
  67     Cc: coordinator@translationproject.org, bug-coreutils@gnu.org
  68     Subject: coreutils-7.1 released [stable]
  69
  70 * Approve the announcement here:
  71   http://lists.gnu.org/mailman/admindb/coreutils-announce
  72
  73 * Announce it on Savannah, too:
  74   From here:
  75     https://savannah.gnu.org/projects/coreutils/
  76   click on the "submit news", then write something like the following:
  77
  78     Subject: coreutils-7.2 released [stable]
  79     The announcement is here:
  80       http://article.gmane.org/gmane.comp.gnu.core-utils.announce/49
  81
  82   Then go here to approve it:
  83     https://savannah.gnu.org/news/approve.php?group=coreutils
  84
  85 * For non-alpha releases, update the on-line manual at
  86
  87     http://www.gnu.org/software/coreutils/manual/
  88
  89   Run `make web-manual', then copy the contents of doc/manual
  90   into a CVS checkout of the coreutils manual repository.
  91   Also edit coreutils.html (FIXME? why?) before doing a CVS commit.
  92
  93     CVS_RSH=ssh \
  94     cvs -d:ext:$USER@cvs.savannah.gnu.org:/web/coreutils co coreutils
  95
  96   Be sure to "cvs add -ko" any files that "cvs status" marks with "?".
  97   That is necessary whenever a new texinfo node is added.  Each becomes
  98   a new file in html_node that must then be "cvs add"ed.