-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) Increment the libnotmuch library version in lib/Makefile.local
+2) Increment the libnotmuch library version in lib/Makefile.local
See the instructions there for how to increment it. The
command below can be useful for inspecting header-file changes
Commit this change.
-4) Run "make VERSION=X.Y release" which will perform the following steps:
+3) 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.
* Push that tag
* Provide some text for the release announcement (see below).
-5) Send a message to notmuch@notmuchmail.org to announce the release.
+4) Send a message to notmuch@notmuchmail.org to announce the release.
Use the text provided from "make release" above, (if for some
reason you lose this message, "make release-message" prints
projects / notmuch / blobdiff