Merge pull request #738 from projecthamster/improved-versioning

Improved versioning

.github/workflows/testing.yml

@@ -82,6 +82,10 @@ jobs:
     steps:
       - name: Prepare repo
         uses: actions/checkout@v2
+        # Fetch history, so we also fetch the previous tag for deriving
+        # the version number
+        with:
+          fetch-depth: 0
       - name: Install system packages
         # It would be good to cache the GNOME Sdk, as it
         # is rather big to download each time.
@@ -105,10 +109,14 @@ jobs:
       - name: Export bundle and try to install it
         run: |
           mkdir -p dist
-          flatpak build-bundle --runtime-repo=https://flathub.org/repo/flathub.flatpakrepo build/flatpak/repo dist/Hamster.flatpak org.gnome.Hamster
-          flatpak --user -y install dist/Hamster.flatpak
+          # Note: For pull requests, this version includes the git hash
+          # of the autogenerated *merge* commit, not the original
+          # to-be-merged commit (because that's also what is tested).
+          VERSION=$(python src/hamster/version.py)
+          flatpak build-bundle --runtime-repo=https://flathub.org/repo/flathub.flatpakrepo build/flatpak/repo "dist/Hamster-$VERSION.flatpak" org.gnome.Hamster
+          flatpak --user -y install "dist/Hamster-$VERSION.flatpak"
       - name: Upload built artifact
         uses: actions/upload-artifact@v2
         with:
           name: Flatpak application
-          path: dist/Hamster.flatpak
+          path: dist/*.flatpak

data/org.gnome.Hamster.GUI.metainfo.xml → data/org.gnome.Hamster.metainfo.xml.in

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop-application">
-  <id>org.gnome.Hamster.GUI</id>
+  <id>org.gnome.Hamster</id>
   <metadata_license>CC0-1.0</metadata_license>
   <project_license>GPL-3.0+ and CC-BY-SA-3.0</project_license>
   <name>Hamster</name>
@@ -44,6 +44,10 @@
   </screenshots>
   ​<translation type="gettext">hamster</translation>
   <url type="homepage">https://github.com/projecthamster/hamster/wiki</url>
+  <releases>
+    <!-- Provide a (clearly) fake date, otherwise flatpak will ignore the entry -->
+    <release version="@VERSION@" date="1980-01-01" />
+  </releases>
   <provides>
     <binary>hamster</binary>
   </provides>

data/wscript

@@ -15,7 +15,13 @@ def build(ctx):
         ctx(features='glib2',
             settings_schema_files=['org.gnome.hamster.gschema.xml'])
 
-    ctx.install_files('${DATADIR}/metainfo', 'org.gnome.Hamster.GUI.metainfo.xml')
+    filename = "org.gnome.Hamster.metainfo.xml"
+    ctx(features = "subst",
+        source= "%s.in" % filename,
+        target= "%s" % filename,
+        dict = ctx.env,
+        install_path = "${DATADIR}/metainfo"
+       )
 
     filename = "org.gnome.Hamster.GUI.desktop"
     ctx(features = "subst",

src/hamster/VERSION

@@ -0,0 +1 @@
+unreleased

src/hamster/__init__.py

@@ -5,23 +5,14 @@
 from gi.repository import Gtk as gtk
 
 from hamster.lib import default_logger
+from hamster.version import get_version
 
 
 logger = default_logger(__name__)
 
-try:
-    # defs.py is created by waf from defs.py.in
-    from hamster import defs
-    __version__ = defs.VERSION
-    installed = True
-except ImportError:
-    # if defs is not there, we are running from sources
-    from subprocess import getstatusoutput
-    rc, output = getstatusoutput("git describe --tags --always --dirty=+")
-    __version__ = "3.0.2" if rc else "{} (uninstalled)".format(output)
-    installed = False
-    del getstatusoutput, rc, output
+(__version__, installed) = get_version()
 
 # cleanup namespace
+del get_version
 del default_logger
 del gtk  # performance is retained

src/hamster/version.py

@@ -0,0 +1,47 @@
+# Should not normally be used directly, use hamster.__version__ and
+# hamster.installed instead
+
+def get_installed_version():
+    try:
+        # defs.py is created by waf from defs.py.in
+        from hamster import defs
+        return defs.VERSION
+    except ImportError:
+        # if defs is not there, we are running from sources
+        return None
+
+def get_uninstalled_version():
+    # If available, prefer the git version, otherwise fall back to
+    # the VERSION file (which is meaningful only in released
+    # versions)
+    from subprocess import getstatusoutput
+    rc, output = getstatusoutput("git describe --tags --always --dirty=+")
+    if rc == 0:
+        import re
+        # Strip "v" prefix that is used in git tags
+        return re.sub(r'^v', '', output)
+    else:
+        from pathlib import Path
+        with open(Path(__file__).parent / 'VERSION', 'r') as f:
+            return f.read()
+
+def get_version():
+    """
+    Figure out the hamster version.
+
+    Returns a tuple with the version string and wether we are installed or not.
+    """
+
+    version = get_installed_version()
+    if version is not None:
+        return (version, True)
+
+    version = get_uninstalled_version()
+    return ("{} (uninstalled)".format(version), False)
+
+
+if __name__ == '__main__':
+    import sys
+    # Intended to be called by waf when installing, so only return
+    # uninstalled version
+    sys.stdout.write(get_uninstalled_version())

wscript

@@ -1,15 +1,13 @@
 # -*- python -*-
 
 
-from subprocess import getstatusoutput
+import subprocess
 
 from waflib import Utils
 
-
-# slight code duplication with hamster/__init__.py, but this is finally cleaner.
-rc, output = getstatusoutput("git describe --tags --always --dirty=+")
-VERSION = "3.0.2" if rc else output
-
+# Reuse code from hamster to figure out the version number to use
+process = subprocess.run(["python3", "src/hamster/version.py"], check=True, stdout=subprocess.PIPE, text=True)
+VERSION = process.stdout
 APPNAME = 'hamster'
 
 top = '.'