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) Verify that the library version in lib/Makefile.local is correct
  20
  21         See the instructions there for how to increment it.
  22
  23         The version should have been updated with any commits that
  24         added API, but do check that that is the case. The command
  25         below can be useful for inspecting header-file changes since
  26         the last release X.Y:
  27
  28                 git diff X.Y..HEAD -- lib/notmuch.h
  29
  30         Note: We currently don't plan to increment
  31         LIBNOTMUCH_VERSION_MAJOR beyond 1, so if there *are*
  32         incompatible changes to the library interface, then
  33         stop. Don't release. Figure out the plan on the notmuch
  34         mailing list.
  35
  36         Commit this change, if any.
  37
  38 3) Upgrade the version in the file "version"
  39
  40         The scheme for the release number is as follows:
  41
  42         A major milestone in usability causes an increase in the major
  43         number, yielding a two-component version with a minor number
  44         of 0, (such as "1.0" or "2.0").
  45
  46         Otherwise, releases with changes in features cause an increase
  47         in the minor number, yielding a two-component version, (such
  48         as "1.1" or "1.2").
  49
  50         Finally, releases that do not change "features" but are merely
  51         bug fixes either add increase the micro number or add it
  52         (starting at ".1" if not present). So a bug-fix release from
  53         "1.0" would be "1.0.1" and a subsequent bug-fix release would
  54         be "1.0.2" etc.
  55
  56         Commit this change.
  57
  58 4) Create an entry for the new release in debian/changelog
  59
  60         The syntax of this file is tightly restricted, but the
  61         available emacs mode (see the dpkg-dev-el package helps).  The
  62         entries here will be the Debian-relevant single-line
  63         description of changes from the NEWS entry. And the version
  64         must match the version in the next step.
  65
  66         Commit this change.
  67
  68         XXX: It would be great if this step were automated as part of
  69         release, (taking entries from NEWS and the version from the
  70         version file, and creating a new commit, etc.)
  71
  72 5) Run "make release" which will perform the following steps:
  73
  74         * Ensure that the version consists only of digits and periods
  75         * Verify that the source tree is clean
  76         * Compile the current notmuch code (aborting release if it fails)
  77         * Run the notmuch test suite (aborting release if it fails)
  78         * Generate the final tar file
  79         * Generate a .sha1 sum file for the tar file
  80         * Sign the sha1sum using your GPG setup (asks for your GPG password)
  81         * Check that no release exists with the current version
  82         * scp the three files to appear on http://notmuchmail.org/releases
  83         * Create a LATEST-notmuch-version file (after deleting any old one)
  84         * Place local copies of the three files in the releases directory
  85         * Tag the entire source tree with a tag of the form X.Y.Z, and sign
  86           the tag with your GPG key (asks for your GPG password, and you
  87           may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match
  88           your public-key's setting or this fails.)
  89         * Push that tag
  90         * Provide some text for the release announcement (see below).
  91
  92 6) Send a message to notmuch@notmuchmail.org to announce the release.
  93
  94         Use the text provided from "make release" above, (if for some
  95         reason you lose this message, "make release-message" prints
  96         it again for you.