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

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