ci: 🎡 add version number to executable

.github/workflows/build_exe.yml

@@ -4,6 +4,9 @@ on:
   push:
     tags:
       - "v[0-9]+.[0-9]+.[0-9]+-?*"
+  pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:
@@ -14,6 +17,7 @@ jobs:
           - platform_name: Windows
             artifact_name: windows
             os: windows-2022
+            version_command: icacls "VERSION" /grant Everyone:F /T /C /Q
             move_command: move dist\mangotango.exe dist\mangotango_windows.exe
             sha_command: pwsh -c "Get-FileHash -Algorithm SHA1 dist\mangotango_windows.exe | Format-Table Hash -HideTableHeaders > dist\mangotango_windows.exe.sha1"
             list_command: dir dist
@@ -70,6 +74,22 @@ jobs:
       - name: Install PyInstaller
         run: pip install pyinstaller
 
+      - name: Print version string (for tag)
+        id: get_version_tag
+        if: ${{ github.ref_type == 'tag' }}
+        run: |
+          python -c "with open('VERSION', 'w', encoding='utf-8') as f: f.write('${{ github.ref_name }}')"
+
+      - name: Print version string (for branch)
+        id: get_version_branch
+        if: ${{ github.ref_type != 'tag' }}
+        run: |
+          python -c "with open('VERSION', 'w', encoding='utf-8') as f: f.write('${{ github.ref_name }}-${{ github.sha }}')"
+
+      - name: Modify version string permission
+        if: ${{ matrix.version_command }}
+        run: ${{ matrix.version_command }}
+
       - name: Build the executable
         run: |
           pyinstaller pyinstaller.spec

.gitignore

@@ -4,3 +4,4 @@ __private__
 /build
 /dist
 /analysis_outputs
+VERSION

components/splash.py

@@ -1,12 +1,27 @@
 from terminal_tools import clear_terminal, wait_for_key
+from pathlib import Path
+import os
 
 
 def splash():
   clear_terminal()
   print(_ascii_splash)
+  print("")
+  print(f"{get_version()}")
+  print("")
   wait_for_key(True)
 
 
+def get_version():
+  root_path = str(Path(__file__).resolve().parent.parent)
+  version_path = os.path.join(root_path, "VERSION")
+  try:
+    with open(version_path, "r") as version_file:
+      return version_file.read().strip()
+  except FileNotFoundError:
+    return "<development version>"
+
+
 _ascii_splash: str = """
        -..*+:..-
        -.=-+%@%##+-=.-

pyinstaller.spec

@@ -10,6 +10,12 @@ a = Analysis(
     pathex=['.'],    # Ensure all paths are correctly included
     binaries=[],
     datas=[
+        # version file, if defined
+        *(
+            [('VERSION', 'VERSION')]
+            if os.path.exists('VERSION') else []
+        ),
+
         # inquirer depends on readchar as a hidden dependency that requires package metadata
         *copy_metadata('readchar'),