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, please 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) Update the debian/libnotmuch1.symbols file
  39
  40         If the library version changed at all (step 2) it probably
  41         means that symbols have changed/been added, in which case the
  42         debian symbols file also needs to be updated:
  43
  44                dpkg-buildpackage -uc -us
  45                dpkg-gensymbols -plibnotmuch1 | patch -p0
  46
  47         Carefully review the changes to debian/libnotmuch1.symbols to
  48         make sure there are no unexpected changes.
  49
  50         Commit this change, if any.
  51
  52 4) Upgrade the version in the file "version"
  53
  54         The scheme for the release number is as follows:
  55
  56         A major milestone in usability causes an increase in the major
  57         number, yielding a two-component version with a minor number
  58         of 0, (such as "1.0" or "2.0").
  59
  60         Otherwise, releases with changes in features cause an increase
  61         in the minor number, yielding a two-component version, (such
  62         as "1.1" or "1.2").
  63
  64         Finally, releases that do not change "features" but are merely
  65         bug fixes either increase the micro number or add it (starting
  66         at ".1" if not present). So a bug-fix release from "1.0" would
  67         be "1.0.1" and a subsequent bug-fix release would be "1.0.2"
  68         etc.
  69
  70         Commit this change.
  71
  72 5) Create an entry for the new release in debian/changelog
  73
  74         The syntax of this file is tightly restricted, but the
  75         available emacs mode (see the dpkg-dev-el package) helps.
  76         The entries here will be the Debian-relevant single-line
  77         description of changes from the NEWS entry. And the version
  78         must match the version in the next step.
  79
  80         Commit this change.
  81
  82         XXX: It would be great if this step were automated as part of
  83         release, (taking entries from NEWS and the version from the
  84         version file, and creating a new commit, etc.)
  85
  86 6) Run "make release" which will perform the following steps.
  87
  88    Note: If any problem occurs during the process, (such as a lintian
  89    warning that you decide should be fixed), you can abort at the
  90    prompt for your GPG passphrase and nothing will have been uploaded
  91    yet.
  92
  93         * Ensure that the version consists only of digits and periods
  94         * Ensure that version and debian/changelog have the same version
  95         * Verify that the source tree is clean
  96         * Compile the current notmuch code (aborting release if it fails)
  97         * Run the notmuch test suite (aborting release if it fails)
  98         * Compile a Debian package
  99         * Copy the tar file from what was made for Debian package
 100         * Generate a .sha1 sum file for the tar file
 101         * Sign the sha1sum using your GPG setup (asks for your GPG password)
 102         * Check that no release exists with the current version
 103         * scp the three files to appear on http://notmuchmail.org/releases
 104         * Create a LATEST-notmuch-version file (after deleting any old one)
 105         * Place local copies of the tar, sha1, and gpg files into releases
 106         * Upload the Debian package
 107         * Place a local copy of the Debian package files in releases
 108         * Tag the entire source tree with a tag of the form X.Y.Z, and sign
 109           the tag with your GPG key (asks for your GPG password, and you
 110           may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match
 111           your public-key's setting or this fails.)
 112         * Push that tag
 113         * Provide some text for the release announcement (see below).
 114
 115 7) Send a message to notmuch@notmuchmail.org to announce the release.
 116
 117         Use the text provided from "make release" above, (if for some
 118         reason you lose this message, "make release-message" prints
 119         it again for you.