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, 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 * Pre-release testing:
  21   Ensure that make check syntax-check succeeds.
  22
  23 * Run "make distcheck"
  24
  25 * Set the date, version number, and release type [stable/alpha/beta] on
  26   line 3 of NEWS, commit that, and tag the release by running e.g.,
  27
  28     build-aux/do-release-commit-and-tag 2.6 stable
  29
  30 * Run the following to create release tarballs.  Your choice selects the
  31   corresponding upload-to destination in the emitted gnupload command.
  32   The different destinations are specified in cfg.mk.  See the definitions
  33   of gnu_ftp_host-{alpha,beta,stable}.
  34
  35     # "TYPE" must be stable, beta or alpha
  36     make TYPE
  37
  38 * Test the tarball.  copy it to a few odd-ball systems and ensure that
  39   it builds and passes all tests.
  40
  41 * While that's happening, write the release announcement that you will
  42   soon post.
  43
  44 Once all the builds and tests have passed,
  45
  46 * Run the gnupload command that was suggested by your "make stable" run above.
  47
  48 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
  49   download all tarball/signature pairs and use gpg --verify to ensure
  50   that they're all valid.
  51
  52 * Push the NEWS-updating changes and the new tag:
  53
  54     v=$(cat .prev-version)
  55     git push origin master tag v$v
  56
  57 * Send the gpg-signed announcement mail, e.g.,
  58
  59     To: info-gnu@gnu.org
  60     Cc: coordinator@translationproject.org, bug-grep@gnu.org
  61     Subject: grep-2.6 released [stable]
  62     Reply-To: bug-grep@gnu.org
  63
  64 * Announce it on Savannah, too:
  65   From here:
  66     https://savannah.gnu.org/projects/grep/
  67   click on the "submit news", then write something like the following:
  68   (If there is no such button, then enable "News" for the project via
  69    the Main -> "Select Features" menu item, or via this link:
  70    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=grep)
  71
  72     Subject: grep-2.6 released [stable]
  73
  74     +verbatim+
  75     ...paste the announcement here...
  76     -verbatim-
  77
  78   Then go here to approve it:
  79     https://savannah.gnu.org/news/approve.php?group=grep
  80
  81 * After each non-alpha release, update the on-line manual accessible via
  82
  83     http://www.gnu.org/software/grep/manual/
  84
  85   by running this:
  86
  87     build-aux/gnu-web-doc-update