Thomas Waldmann avatar Thomas Waldmann committed 111f0ab

first draft of release process

Comments (0)

Files changed (1)

HowToRelease.wiki

+Note:
+* work in progress, trying to document how releasing whoosh works
+* created in the hope to make the release process better and to avoid forgetting something
+
+= Creating a release =
+# switch to correct branch, e.g. {{{ hg up -C 2.4x }}}
+# check {{{ __version__ }}} in {{{ whoosh/__init__.py }}}
+** note: the version number should be already correct (see below)
+# check and update the {{{ docs/source/releases/*.rst }}}
+** list fixed issues
+** list new features
+# check for completeness:
+** new files? {{{ MANIFEST.in }}}
+** new code packages/modules? {{{ setup.py }}}
+# {{{ hg clone whoosh whoosh-rel }}}
+** touches all files so their mtime is current, this avoids trouble for people not using --force option with setup.py install
+** only stuff in the repo is in whoosh-rel dir, no other crap
+# {{{ cd whoosh-rel ; make dist }}}
+# Upload the .tar.gz and .zip release files to pypi
+# Tag the release, e.g.: {{{ hg tag -r 12345678abcd -m "Added tag 2.4.2 for changeset 12345678abcd" 2.4.2 }}}
+# Update {{{ __version__ }}} in {{{ whoosh/__init__.py }}} so that the current repo code has a higher version number than the current release.
+# {{{ hg commit -m "Bumping version number." }}}
+# Update http://pypi.python.org/pypi/Whoosh/ by using: {{{ python setup.py register }}}
+# Announcements: 
+** whoosh mailing list
+** (add more?)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.