RELEASING: Update instructions for new version technique.
[notmuch] / 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) Verify that the notmuch test suite passes.
14
15         Currently this is by running:
16
17                 ./test/notmuch-test
18
19         And manually verifying that every test says PASS. We plan to
20         fix this to automatically check the results and even to
21         automatically run the test suite as part of a Makefile target
22         described below.
23
24 4) Increment the libnotmuch library version in lib/Makefile.local
25
26         See the instructions there for how to increment it. The
27         command below can be useful for inspecting header-file changes
28         since the last release X.Y.Z:
29
30                 git diff X.Y.Z..HEAD -- lib/notmuch.h
31
32         Note: We currently don't plan to increment
33         LIBNOTMUCH_VERSION_MAJOR beyond 1, so if there *are*
34         incompatible changes to the library interface, then
35         stop. Don't release. Figure out the plan on the notmuch
36         mailing list.
37
38         Commit this change.
39
40 5) Run "make VERSION=X.Y release" which will perform the following steps:
41
42    For the X.Y version, we'll generally just increment Y. But for
43    major milestones of usability we're increment X as well.
44
45         * Check that the notmuch version consists of only two components
46         * Check that no release exists with the current version
47         * Verify that "make dist" completes successfully
48         * Generate the final tar file
49         * Generate an sha1sum file
50         * Sign the sha1sum using your GPG setup (asks for your GPG password)
51         * scp the three files to appear on http://notmuchmail.org/releases
52         * Place local copies of the three files in the releases directory
53         * Create a LATEST-notmuch-version file (after deleting any old one)
54         * Tag the entire source tree with a tag of the form X.Y.Z, and sign
55           the tag with your GPG key (asks for your GPG password, and you
56           may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match
57           your public-key's setting or this fails.)
58         * Push that tag
59         * Provide some text for the release announcement (see below).
60
61 6) Increment the notmuch version by adding a .1 micro number, commit, and push.
62
63 7) Send a message to notmuch@notmuchmail.org to announce the release.
64
65         Use the text provided from "make release" above, (if for some
66         reason you lose this message, "make release-message" prints
67         it again for you.