Simplify versioning scheme by removing VERSION.

Author: Feras A Saad

CONTRIBUTING.md

@@ -125,45 +125,20 @@ Our version scheme, compatible with [PEP 440](https://www.python.org/dev/peps/pe
 We do not currently make any semantic API compatibility guarantees about the
 meaning of `<major>`, `<minor>`, and `<teeny>`.
 
-In the source tree, the [VERSION](./VERSION) file contains either the
-current release version number, or the most recent tagged version
-number followed by a plus sign `+`.  In that case, a suffix will be
-added to the most recent version number, derived from `git describe`,
-of the form:
+To create a new release (only creating tagged releases from `master` branch):
 
-    .post<N>+g<commitid>[.<dirty>]
+  1. Check-out the master branch with a clean working directory.
 
-The Git tag for a tagged version is named with a `v` prefix.  Note
-that the content of VERSION for any tagged version MUST NOT include a
-`+` suffix, so that `cat VERSION` is sufficient to find the version
-number, and `git describe` is not necessary.
+  2. Create an annotated tag using one of the three forms compatible with PEP
+     440 shown above. For example: `git tag -a -m v0.2.42 v0.2.42`
 
-To tag a new version:
+  3. Run `python setup.py build`.
 
-1. Set `VERSION` to the new version, say `0.2.42`:
+  4. Run `cat src/version.py` and confirm that the version matches the tag. If
+     the version contains `dirty`, `post`, or a commit id then you have done
+     something wrong, so please ask for help.
 
-    ```
-    $ echo 0.2.42 > VERSION
-    $ git commit -m 'Bump version to 0.2.42.' VERSION
-    ```
-
-2. Tag it with an annotated tag:
-
-    ```
-    $ git tag -a -m v0.2.42 v0.2.42
-    ```
-
-   If you want, you can include release notes in the annotated tag
-   message.
-
-3. Append `+` to the version in VERSION:
-
-    ```
-    $ echo 0.2.42+ > VERSION
-    $ git commit -m 'Bump version to 0.2.42+.' VERSION
-    ```
-
-Make sure when you push that you pass `--tags` to `git push`.
+  5. Run `git push origin master --tags`.
 
 [1]: https://github.com/probcomp/bayeslite/blob/9555f5fd614e7dd960dcf8b54ae8edc5b69d7d1a/src/backends/cgpm_backend.py#L835-L836
 [2]: https://github.com/probcomp/bayeslite/blob/9555f5fd614e7dd960dcf8b54ae8edc5b69d7d1a/src/bqlfn.py#L95-L96

MANIFEST.in

@@ -1,6 +1,5 @@
 include LICENSE.txt
 include README.md
-include VERSION
 include check.sh
 include external/README
 include external/lemonade/COPYING

VERSION

@@ -38,28 +38,31 @@ def set_undefined_options(self, opt, val):
             Command.set_undefined_options(self, opt, val)
 
 def get_version():
-    with open('VERSION', 'rb') as f:
-        version = f.read().strip()
-
-    # Append the Git commit id if this is a development version.
-    if version.endswith('+'):
-        import re
-        import subprocess
-        version = version[:-1]
-        tag = 'v' + version
-        desc = subprocess.check_output([
-            'git', 'describe', '--dirty', '--long', '--match', tag,
-        ])
-        match = re.match(r'^v([^-]*)-([0-9]+)-(.*)$', desc)
-        assert match is not None
-        verpart, revpart, localpart = match.groups()
-        assert verpart == version
-        # Local part may be g0123abcd or g0123abcd-dirty.  Hyphens are
-        # not kosher here, so replace by dots.
+    import re
+    import subprocess
+    # git describe a commit using the most recent tag reachable from it.
+    # Release tags start with v* (XXX what about other tags starting with v?)
+    # and are of the form `v1.1.2`.
+    #
+    # The output `desc` will be of the form v1.1.2-2-gb92bef6[-dirty]:
+    # - verpart     v1.1.2
+    # - revpart     2
+    # - localpart   gb92bef6[-dirty]
+    desc = subprocess.check_output([
+        'git', 'describe', '--dirty', '--long', '--match', 'v*',
+    ])
+    match = re.match(r'^v([^-]*)-([0-9]+)-(.*)$', desc)
+    assert match is not None
+    verpart, revpart, localpart = match.groups()
+    # Create a post version.
+    if revpart > '0' or 'dirty' in localpart:
+        # Local part may be g0123abcd or g0123abcd-dirty.
+        # Hyphens not kosher here, so replace by dots.
         localpart = localpart.replace('-', '.')
         full_version = '%s.post%s+%s' % (verpart, revpart, localpart)
+    # Create a release version.
     else:
-        full_version = version
+        full_version = verpart
 
     # Strip the local part if there is one, to appease pkg_resources,
     # which handles only PEP 386, not PEP 440.