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: ./bootstrap
  17
  18 FIXME: enable excluded programs like arch? to get their manual pages?
  19
  20 * Pre-release testing:
  21   Ensure that make check syntax-check succeeds.
  22   On at least one SELinux-enabled (enforcing) and one non-SELinux system,
  23     run all tests, both root-only and regular.
  24   Run *all* non-root tests, including expensive and very expensive ones i.e.,
  25     run this: make -j1 check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
  26
  27   Run the root-only tests:
  28   sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k check-root
  29
  30 * Run "make distcheck"
  31
  32 * Set the date, version number, and release type [stable/alpha/beta] on
  33   line 3 of NEWS, commit that, and tag the release by running e.g.,
  34
  35     build-aux/do-release-commit-and-tag 8.1 beta
  36
  37 * Run the following to create release tarballs.  Your choice selects the
  38   corresponding upload-to destination in the emitted gnupload command.
  39   The different destinations are specified in cfg.mk.  See the definitions
  40   of gnu_ftp_host-{alpha,beta,stable}.
  41
  42     # "TYPE" must be stable, beta or alpha
  43     make TYPE
  44
  45 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  46   it builds and passes all tests.
  47
  48 * While that's happening, write the release announcement that you will
  49   soon post.
  50
  51 Once all the builds and tests have passed,
  52
  53 * Run the gnupload command that was suggested by your "make stable" run above.
  54
  55 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  56   download all tarball/signature pairs and use gpg --verify to ensure
  57   that they're all valid.
  58
  59 * Push the NEWS-updating changes and the new tag:
  60
  61     v=$(cat .prev-version)
  62     git push origin master tag v$v
  63
  64 * Send the gpg-signed announcement mail, e.g.,
  65
  66     To: info-gnu@gnu.org, coreutils-announce@gnu.org
  67     Cc: coordinator@translationproject.org, bug-coreutils@gnu.org
  68     Subject: coreutils-8.0 released [beta]
  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   (If there is no such button, then enable "News" for the project via
  78    the Main -> "Select Features" menu item, or via this link:
  79    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=coreutils)
  80
  81     Subject: coreutils-0.0 released [beta]
  82     The announcement is here:
  83       http://article.gmane.org/gmane.comp.gnu.core-utils.announce/54
  84
  85   Then go here to approve it:
  86     https://savannah.gnu.org/news/approve.php?group=coreutils
  87
  88 * After each non-alpha release, update the on-line manual accessible via
  89
  90     http://www.gnu.org/software/coreutils/manual/
  91
  92   by running this:
  93
  94     build-aux/gnu-web-doc-update