[tor-commits] [bridgedb/master] Add maintainer instructions to README for now.

isis at torproject.org isis at torproject.org
Sun Jan 12 06:06:29 UTC 2014


commit ea1c8683765b032dbf02a25f204e4e4fa782af04
Author: Isis Lovecruft <isis at torproject.org>
Date:   Tue Aug 20 01:29:43 2013 +0000

    Add maintainer instructions to README for now.
    
     * TODO We need a separate place (and preferably git repo for maintainer
       docs, scripts, etc.). I've started putting these things in maint/ in
       the top-level of bridgedb.git, but since I think that service
       maintainance should be kept separate from the software maintainance,
       I haven't committed them yet. That said, here are the instructions
       for bumping versions, for lack of a better place to put them.
---
 README |   31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README b/README
index 5e5c296..3dda4f9 100644
--- a/README
+++ b/README
@@ -256,3 +256,34 @@ equal to "get bridges" will get answered, assuming the domain is okay.
 
 ### Support
 Send your questions to isis (A) torproject (circle) org.
+
+### Maintainer's Notes
+
+#### Bumping the version number
+
+Bumping the version number at release time (which, for BridgeDB really means
+deploy time, as of right now) means doing the following:
+
+    $ git checkout develop
+    [merge some fix/bug/feature/etc branches]
+    $ git checkout -b release-0.0.2 develop
+    $ git tag -a -s bridgedb-0.0.2
+    [pip maintainance commands *would* go here, if we ever have any]
+    $ git checkout master
+    $ git merge -S --no-ff release-0.0.2
+    $ git checkout develop
+    $ git merge -S --no-ff master
+    $ git push <remote> master develop
+
+And be sure not to forget to do:
+
+    $ git push --tags
+
+If the currently installed version is *not* from one of the signed tags, the
+version number attribute created by versioneer will be the short ID of the git
+commit from which the installation took place, prefixed with the most recent
+tagged release at that point, i.e.:
+
+    >>> import bridgedb
+    >>> bridgedb.__version__
+    0.0.1-git528ff30c





More information about the tor-commits mailing list