only use annotated tags for version calculation

unsecureio · Jan 7, 2018 · 15f525e · 15f525e
1 parent 94a173a
commit 15f525e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/mitmproxy/version.py b/mitmproxy/version.py
@@ -33,7 +33,7 @@ def get_version(dev: bool = False, build: bool = False, refresh: bool = False) -
         here = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
         try:
             git_describe = subprocess.check_output(
-                ['git', 'describe', '--tags', '--long'],
+                ['git', 'describe', '--long'],
                 stderr=subprocess.STDOUT,
                 cwd=here,
             )

diff --git a/release/README.md b/release/README.md
@@ -5,6 +5,10 @@ Make sure run all these steps on the correct branch you want to create a new rel
 - Update CHANGELOG
 - Verify that all CI tests pass
 - Tag the release and push to Github
+  - For alphas, betas, and release candidates, use lightweight tags.  
+    This is necessary so that the .devXXXX counter does not reset.
+  - For final releases, use annotated tags.  
+    This makes the .devXXXX counter reset.
 - Wait for tag CI to complete
 
 ## GitHub Release

diff --git a/test/mitmproxy/test_version.py b/test/mitmproxy/test_version.py
@@ -32,5 +32,5 @@ def test_get_version():
         m.return_value = b"tag-2-cafecafe"
         assert version.get_version(True, True) == "3.0.0.dev2-0xcafecaf"
 
-        m.side_effect = subprocess.CalledProcessError(-1, 'git describe --tags --long')
+        m.side_effect = subprocess.CalledProcessError(-1, 'git describe --long')
         assert version.get_version(True, True) == "3.0.0"