mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-26 19:34:51 +01:00
a29f49b943
We actually want this version to be incremented by the commits that extend the interface. So the release process really is not to just verify two things (NEWS and libnotmuch version), then run "make VERSION=x.y release", and send the mail. Quite nice.
65 lines
2.7 KiB
Text
65 lines
2.7 KiB
Text
Here are the steps to follow to create a new notmuch release.
|
|
|
|
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.
|
|
|
|
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).
|
|
|
|
2) Verify that the library version in lib/Makefile.local is correct
|
|
|
|
See the instructions there for how to increment it.
|
|
|
|
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:
|
|
|
|
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*
|
|
incompatible changes to the library interface, then
|
|
stop. Don't release. Figure out the plan on the notmuch
|
|
mailing list.
|
|
|
|
Commit this change, if any.
|
|
|
|
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.
|
|
|
|
* 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 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
|
|
* 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).
|
|
|
|
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
|
|
it again for you.
|