git.notmuchmail.org Git - notmuch/blob - RELEASING

   1 Here are the steps to follow to create a new notmuch release:
   2
   3 1) Verify that what you want to release is committed. The release
   4    process will release the code from the current HEAD commit.
   5
   6 2) Verify that the NEWS file is up to date.
   7
   8         Read through the entry at the top of the NEWS file and see if
   9         you are aware of any major features recently added that are
  10         not mentioned there. If so, pleas add them, (and ask the
  11         authors of the commits to update NEWS in the future).
  12
  13 3) Increment the libnotmuch library version in lib/Makefile.local
  14
  15         See the instructions there for how to increment it. The
  16         command below can be useful for inspecting header-file changes
  17         since the last release X.Y.Z:
  18
  19                 git diff X.Y.Z..HEAD -- lib/notmuch.h
  20
  21         Note: We currently don't plan to increment
  22         LIBNOTMUCH_VERSION_MAJOR beyond 1, so if there *are*
  23         incompatible changes to the library interface, then
  24         stop. Don't release. Figure out the plan on the notmuch
  25         mailing list.
  26
  27         Commit this change.
  28
  29 4) Run "make VERSION=X.Y release" which will perform the following steps:
  30
  31    For the X.Y version, we'll generally just increment Y. But for
  32    major milestones of usability we're increment X as well.
  33
  34         * Compile the current notmuch code (aborting release if it fails)
  35         * Run the notmuch test suite (aborting release if it fails)
  36         * Check that the notmuch version consists of only two components
  37         * Check that no release exists with the current version
  38         * Verify that "make dist" completes successfully
  39         * Generate the final tar file
  40         * Generate an sha1sum file
  41         * Sign the sha1sum using your GPG setup (asks for your GPG password)
  42         * scp the three files to appear on http://notmuchmail.org/releases
  43         * Place local copies of the three files in the releases directory
  44         * Create a LATEST-notmuch-version file (after deleting any old one)
  45         * Tag the entire source tree with a tag of the form X.Y.Z, and sign
  46           the tag with your GPG key (asks for your GPG password, and you
  47           may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match
  48           your public-key's setting or this fails.)
  49         * Push that tag
  50         * Provide some text for the release announcement (see below).
  51
  52 5) Increment the notmuch version by adding a .1 micro number, commit, and push.
  53
  54 6) Send a message to notmuch@notmuchmail.org to announce the release.
  55
  56         Use the text provided from "make release" above, (if for some
  57         reason you lose this message, "make release-message" prints
  58         it again for you.