Add script to generate version file dynamically

Author: mathoudebine

.github/workflows/generate-windows-installer.yml

@@ -26,6 +26,10 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install -r requirements.txt
 
+    - name: Set version number for PyInstaller
+      run: |
+        python.exe tools\windows-installer\generate-version-info.py ${{github.event.release.tag_name}}
+
     - name: Run PyInstaller to create binaries
       run: |
         pyinstaller.exe --noconfirm turing-system-monitor.spec

tools/windows-installer/generate-version-info.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+# turing-smart-screen-python - a Python system monitor and library for USB-C displays like Turing Smart Screen or XuanFang
+# https://github.com/mathoudebine/turing-smart-screen-python/
+#
+# Copyright (C) 2021-2023  Matthieu Houdebine (mathoudebine)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# generate-version-info.py: generate PyInstaller .exe version file from version number in argument
+# Inspired from PyInstaller/utils/cliutils/grab_version.py and PyInstaller/utils/win32/versioninfo.py
+
+import codecs
+import sys
+from pathlib import Path
+
+from PyInstaller.utils.win32 import versioninfo
+
+# Load generic file and parse version info
+VERSION_INFO_FILE = str(Path(__file__).parent.resolve()) + "/pyinstaller-version-info.txt"
+info = versioninfo.load_version_info_from_text_file(VERSION_INFO_FILE)
+
+if not info:
+    raise SystemExit("Error: VersionInfo resource not found in exe")
+
+# Get version number from argument
+version = sys.argv[1].split('.')
+major = int(version[0])
+minor = int(version[1])
+revision = int(version[2])
+build = 0  # For this project we only use 3-digit versions
+
+# Update FixedFileInfo version
+info.ffi.fileVersionMS = (major << 16) + minor
+info.ffi.fileVersionLS = (revision << 16) + build
+info.ffi.productVersionMS = (major << 16) + minor
+info.ffi.productVersionLS = (revision << 16) + build
+
+# Update StringFileInfo version
+for elem in info.kids[0].kids[0].kids:
+    if elem.name == 'ProductVersion' or elem.name == 'FileVersion':
+        elem.val = f"{major}.{minor}.{revision}"
+
+# Update version file with new info, to be used by PyInstaller
+with codecs.open(VERSION_INFO_FILE, 'w', 'utf-8') as fp:
+    fp.write(str(info))
+
+print(f"Version info written to: {VERSION_INFO_FILE}")

tools/windows-installer/pyinstaller-version-info.txt

@@ -6,8 +6,8 @@ VSVersionInfo(
   ffi=FixedFileInfo(
     # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
     # Set not needed items to zero 0.
-    filevers=(3, 7, 0, 0),
-    prodvers=(3, 7, 0, 0),
+    filevers=(1, 2, 3, 4),
+    prodvers=(1, 2, 3, 4),
     # Contains a bitmask that specifies the valid bits 'flags'r
     mask=0x0,
     # Contains a bitmask that specifies the Boolean attributes of the file.
@@ -31,8 +31,8 @@ VSVersionInfo(
         '040904b0',
         [StringStruct('FileDescription', 'System Monitor for USB smart screens like Turing'),
         StringStruct('ProductName', 'Turing System Monitor'),
-        StringStruct('ProductVersion', '3.7.0'),
-        StringStruct('FileVersion', '3.7.0')])
+        StringStruct('ProductVersion', '1.2.3'),
+        StringStruct('FileVersion', '1.2.3')])
       ]), 
     VarFileInfo([VarStruct('Translation', [1033, 1200])])
   ]

tools/windows-installer/turing-system-monitor.iss

@@ -18,8 +18,8 @@ AppName={#MyAppName}
 AppVersion={#MyAppVersion}
 AppPublisher={#MyAppPublisher}
 AppPublisherURL={#MyAppURL}
-AppSupportURL={#MyAppURL}
-AppUpdatesURL={#MyAppURL}
+AppSupportURL={#MyAppURL}/wiki
+AppUpdatesURL={#MyAppURL}/releases
 DefaultDirName={autopf}\{#MyAppName}
 DefaultGroupName={#MyAppName}
 OutputBaseFilename=turing-system-monitor_{#MyAppVersion}