# repository), we add a third digit, (0.1.1, 0.1.2, etc.), and
# increment it occasionally, (such as after a big batch of commits are
# merged.
-NOTMUCH_VERSION=0.1.1
+PACKAGE=notmuch
+VERSION=0.1.1
+
+RELEASE_HOST=notmuchmail.org
+RELEASE_DIR=/srv/notmuchmail.org/www/releases
+TAR_FILE=$(PACKAGE)-$(VERSION).tar.gz
+SHA1_FILE=$(TAR_FILE).sha1
+GPG_FILE=$(SHA1_FILE).asc
# Get settings from the output of configure by running it to generate
# Makefile.config if it doesn't exist yet. And add Makefile.config to
extra_cxxflags :=
# Smash together user's values with our extra values
-FINAL_CFLAGS = -DNOTMUCH_VERSION=$(NOTMUCH_VERSION) $(CFLAGS) $(WARN_CFLAGS) $(CONFIGURE_CFLAGS) $(extra_cflags)
+FINAL_CFLAGS = -DNOTMUCH_VERSION=$(VERSION) $(CFLAGS) $(WARN_CFLAGS) $(CONFIGURE_CFLAGS) $(extra_cflags)
FINAL_CXXFLAGS = $(CXXFLAGS) $(WARN_CXXFLAGS) $(CONFIGURE_CXXFLAGS) $(extra_cflags) $(extra_cxxflags)
FINAL_LDFLAGS = $(LDFLAGS) $(CONFIGURE_LDFLAGS)
endif
endif
+$(TAR_FILE):
+ git archive --format=tar --prefix=$(PACKAGE)-$(VERSION)/ HEAD | gzip > $(TAR_FILE)
+ @echo "Source is ready for release in $(TAR_FILE)"
+
+$(SHA1_FILE): $(TAR_FILE)
+ sha1sum $^ > $@
+
+$(GPG_FILE): $(SHA1_FILE)
+ @echo "Please enter your GPG password to sign the checksum."
+ gpg --armor --sign $^
+
.PHONY: dist
-dist:
- git archive --format=tar --prefix=notmuch-$(NOTMUCH_VERSION)/ HEAD | gzip > notmuch-$(NOTMUCH_VERSION).tar.gz
- @echo "Source is ready for release in notmuch-$(NOTMUCH_VERSION).tar.gz"
+dist: $(TAR_FILE)
+
+.PHONY: release
+release: release-verify-newer $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE)
+ mkdir -p releases
+ scp $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) $(RELEASE_HOST):$(RELEASE_DIR)
+ mv $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) releases
+ ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-[0-9]* && ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(PACKAGE)-$(VERSION)"
+ git tag -s -m "$(PACKAGE) $(VERSION) release" $(VERSION)
+
+.PHONY: release-verify-version
+release-verify-version:
+ @echo -n "Checking that $(VERSION) is a two-component version..."
+ @if echo $(VERSION) | grep -q -v -x '[0-9]*\.[0-9]*'; then \
+ (echo "Ouch." && \
+ echo "Before releasing the notmuch version should be a two-component value." && false);\
+ else :; fi
+ @echo "Good."
+
+.PHONY: release-verify-newer
+release-verify-newer: release-verify-version
+ @echo -n "Checking that no $(VERSION) release already exists..."
+ @ssh $(RELEASE_HOST) test ! -e $(RELEASE_DIR)/$(TAR_FILE) \
+ || (echo "Ouch." && echo "Found: $(RELEASE_HOST):$(RELEASE_DIR)/$(TAR_FILE)" \
+ && echo "Refusing to replace an existing release." && false)
+ @echo "Good."
# The user has not set any verbosity, default to quiet mode and inform the
# user how to enable verbose compiles.
--- /dev/null
+Notmuch 0.1 (2010-04-05)
+========================
+This is the first release of the notmuch mail system.
+
+It includes the libnotmuch library, the notmuch command-line
+interface, and an emacs-based interface to notmuch.
+
+Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian
+1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had
+a performance bug that made notmuch very slow when modifying
+tags. This would cause distracting pauses when reading mail while
+notmuch would wait for Xapian when removing the "inbox" and "unread"
+tags from messages in a thread.
--- /dev/null
+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.
+
+2) 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
+
+ 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.
+
+4) 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
+ since the last release X.Y.Z:
+
+ git diff X.Y.Z..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.
+
+5) Increment the notmuch version in Makefile.local
+
+ For most releases we'll just increment the minor number. For
+ major milestones of usability we'll increment the major
+ number.
+
+ Commit this change.
+
+6) Run "make release" which will perform the following steps:
+
+ * 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
+ * Generate the final tar file
+ * Generate an sha1sum file
+ * Sign the sha1sum using your GPG setup (asks for your GPG password)
+ * 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)
+ * 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.)
+ * Provide some text for the release announcement (see below).
+ If for some reason you lost this message, "make release-publish-message"
+ prints it 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.
+
+ Use the text from the new entry to NEWS.
# As such, this number must be incremented for any incompatible change to
# the library interface, (such as the deletion of an API or a major
# semantic change that breaks formerly functioning code).
+#
+# Note: We don't currently have plans to increment this at this time.
+# If we *do* want to make an incompatible change to the library
+# interface, we'll have to decide whether to increment this (creating
+# a new soname) or to introduce symbol versioning to be able to
+# provide support for both old and new interfaces without having to
+# increment this.
LIBNOTMUCH_VERSION_MAJOR = 1
# The minor version of the library interface. This should be incremented at
projects / notmuch / commitdiff