[tor-commits] [bridgedb/master] Add more documentation about how to use the automatic versioning.

[isis at torproject.org]

commit 0ad67d767bd258b177f26e2ad95aa3f3894ec1e8
Author: Isis Lovecruft <isis at torproject.org>
Date:   Thu Oct 3 06:15:14 2013 +0000

    Add more documentation about how to use the automatic versioning.
---
 setup.py |   18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/setup.py b/setup.py
index b043720..9482539 100644
--- a/setup.py
+++ b/setup.py
@@ -22,8 +22,22 @@ except ImportError:
 import versioneer
 versioneer.versionfile_source = 'lib/bridgedb/_version.py'
 versioneer.versionfile_build = 'bridgedb/_version.py'
-versioneer.tag_prefix = 'bridgedb-' # tags should be like 'bridgedb-0.1.0'
-versioneer.parentdir_prefix = 'bridgedb-' # tarballs unpack to 'bridgedb-0.1.0'
+
+# when creating a release, tags should be prefixed with 'bridgedb-', like so:
+#
+#     git checkout -b release-6.6.6 develop
+#     [do some stuff, merge whatever, test things]
+#     git tag -S bridgedb-6.6.6
+#     git push tpo-common --tags
+#     git checkout master
+#     git merge -S --no-ff release-6.6.6
+#     git checkout develop
+#     git merge -S --no-ff master
+#     git branch -d release-6.6.6
+#
+versioneer.tag_prefix = 'bridgedb-'
+# source tarballs should unpack to a directory like 'bridgedb-6.6.6'
+versioneer.parentdir_prefix = 'bridgedb-'
 
 def get_cmdclass():
     """Get our cmdclass dictionary for use in setuptool.setup().