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