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 * Run bootstrap one last time.  This downloads any new translations:
  17
  18     ./bootstrap
  19
  20 FIXME: enable excluded programs like arch? to get their manual pages?
  21
  22 * Pre-release testing:
  23
  24   Run the following on at least one SELinux-enabled (enforcing) and
  25   one non-SELinux system:
  26
  27     make distcheck
  28     make -j1 check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
  29     sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k check-root
  30
  31   Note the -j1 above.  If you use -jN, for larger N, some of the expensive
  32   tests are likely to interfere with concurrent performance-measuring or
  33   timing-sensitive tests, resulting in spurious failures.
  34
  35   If "make distcheck" doesn't run "make syntax-check" for you, then run
  36   it manually:
  37
  38     make syntax-check
  39
  40 * Set the date, version number, and release type [stable/alpha/beta] on
  41   line 3 of NEWS, commit that, and tag the release by running e.g.,
  42
  43     build-aux/do-release-commit-and-tag X.Y stable
  44
  45 * Run the following to create release tarballs.  Your choice selects the
  46   corresponding upload-to destination in the emitted gnupload command.
  47   The different destinations are specified in cfg.mk.  See the definitions
  48   of gnu_ftp_host-{alpha,beta,stable}.
  49
  50     # "TYPE" must be stable, beta or alpha
  51     make TYPE
  52
  53 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  54   it builds and passes all tests.
  55
  56 * While that's happening, write the release announcement that you will
  57   soon post.  Start with the template, $HOME/announce-coreutils-X.Y
  58   that was just created by that "make" command.
  59
  60 Once all the builds and tests have passed,
  61
  62 * Run the gnupload command that was suggested by your "make stable" run above.
  63
  64 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  65   download all tarball/signature pairs and use gpg --verify to ensure
  66   that they're all valid.
  67
  68 * Push the NEWS-updating changes and the new tag:
  69
  70     v=$(cat .prev-version)
  71     git push origin master tag v$v
  72
  73 * Announce it on Savannah first, so you can include the preferable
  74   savannah.org announcement link in the email message.
  75
  76   From here:
  77     https://savannah.gnu.org/projects/coreutils/
  78   click on the "submit news", then write something like the following:
  79   (If there is no such button, then enable "News" for the project via
  80    the Main -> "Select Features" menu item, or via this link:
  81    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=coreutils)
  82
  83     Subject: coreutils-X.Y released [stable]
  84     +verbatim+
  85     ...paste the announcement here...
  86     -verbatim-
  87
  88   Then go here to approve it:
  89     https://savannah.gnu.org/news/approve.php?group=coreutils
  90
  91 * Send the announcement email message.
  92
  93 * Approve the announcement here:
  94   http://lists.gnu.org/mailman/admindb/coreutils-announce
  95
  96 * After each non-alpha release, update the on-line manual accessible via
  97
  98     http://www.gnu.org/software/coreutils/manual/
  99
 100   by running this:
 101
 102     build-aux/gnu-web-doc-update