-Here are the steps to follow to create a new notmuch release:
+Here are the steps to follow to create a new notmuch release.
-1) Verify that what you want to release is committed. The release
- process will release the code from the current HEAD commit.
+These steps assume that a process (not described here) has already
+been followed to determine the features and bug fixes to be included
+in a release, and that adequate testing by the community has already
+been performed. The little bit of testing performed here is a safety
+check, and not a substitute for wider testing.
-2) Verify that the NEWS file is up to date.
+OK, so the code to be released is present and committed to your git
+repository. From here, there are just a few steps to release:
+
+1) Verify that the NEWS file is up to date.
Read through the entry at the top of the NEWS file and see if
you are aware of any major features recently added that are
not mentioned there. If so, pleas add them, (and ask the
authors of the commits to update NEWS in the future).
-3) Verify that the notmuch test suite passes.
-
- Currently this is by running:
-
- ./test/notmuch-test
+2) Verify that the library version in lib/Makefile.local is correct
- And manually verifying that every test says PASS. We plan to
- fix this to automatically check the results and even to
- automatically run the test suite as part of a Makefile target
- described below.
+ See the instructions there for how to increment it.
-4) Increment the libnotmuch library version in lib/Makefile.local
+ The version should have been updated with any commits that
+ added API, but do check that that is the case. The command
+ below can be useful for inspecting header-file changes since
+ the last release X.Y:
- See the instructions there for how to increment it. The
- command below can be useful for inspecting header-file changes
- since the last release X.Y.Z:
-
- git diff X.Y.Z..HEAD -- lib/notmuch.h
+ git diff X.Y..HEAD -- lib/notmuch.h
Note: We currently don't plan to increment
LIBNOTMUCH_VERSION_MAJOR beyond 1, so if there *are*
stop. Don't release. Figure out the plan on the notmuch
mailing list.
- Commit this change.
+ Commit this change, if any.
-5) Increment the notmuch version in Makefile.local
+3) Create an entry for the new release in debian/changelog
- For most releases we'll just increment the minor number. For
- major milestones of usability we'll increment the major
- number.
+ The syntax of this file is tightly restricted, but the
+ available emacs mode (see the dpkg-dev-el package helps). The
+ entries here will be the Debian-relevant single-line
+ description of changes from the NEWS entry. And the version
+ must match the version in the next step.
Commit this change.
-6) Run "make release" which will perform the following steps:
+ XXX: It would be great if this step were automated as part of
+ release, (taking entries from NEWS and the version from the
+ VERSION, and creating a new commit).
- * Check that the notmuch version consists of only two components
- * Check that no release exists with the current version
- * Verify that "make dist" completes successfully
+4) Run "make VERSION=X.Y release" which will perform the following steps:
+
+ For the X.Y version, we'll generally just increment Y. But for
+ major milestones of usability we're increment X as well.
+
+ * Ensure that the caller passed VERSION=X.Y
+ * Verify that the source tree is clean
+ * Compile the current notmuch code (aborting release if it fails)
+ * Run the notmuch test suite (aborting release if it fails)
* Generate the final tar file
- * Generate an sha1sum file
+ * Generate a .sha1 sum file for the tar file
* Sign the sha1sum using your GPG setup (asks for your GPG password)
+ * Check that no release exists with the current version
* scp the three files to appear on http://notmuchmail.org/releases
- * Place local copies of the three files in the releases directory
* Create a LATEST-notmuch-version file (after deleting any old one)
+ * Place local copies of the three files in the releases directory
* Tag the entire source tree with a tag of the form X.Y.Z, and sign
the tag with your GPG key (asks for your GPG password, and you
may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match
your public-key's setting or this fails.)
* Push that tag
* Provide some text for the release announcement (see below).
- If for some reason you lose this message, "make release-message"
- prints it again for you.
-
-7) Increment the notmuch version by adding a .1 micro number, commit, and push.
-8) Send a message to notmuch@notmuchmail.org to announce the release.
+5) Send a message to notmuch@notmuchmail.org to announce the release.
- Use the text from the new entry to NEWS.
+ Use the text provided from "make release" above, (if for some
+ reason you lose this message, "make release-message" prints
+ it again for you.
projects / notmuch / blobdiff