[build] Allow building development .msi artifacts

Author: Breakthrough

appveyor.yml

@@ -72,7 +72,9 @@ install:
   # CI pyinstaller output - new transitive deps, Python patch updates, etc.).
   # Does not touch version/GUID fields - those are committed to the .aip on the
   # release tag and must stay stable across rebuilds for upgrade-chain integrity.
-  - python scripts/bump_installer.py --sync-only
+  # On non-tag builds, also pass --dev so the MSI is named PySceneDetect-{ver}-dev-win64.msi
+  # (keeps dev artifacts distinguishable from signed releases).
+  - if "%APPVEYOR_REPO_TAG%"=="true" (python scripts/bump_installer.py --sync-only) else (python scripts/bump_installer.py --sync-only --dev)
   # Create MSI installer
   - AdvancedInstaller.com /build packaging/windows/installer/PySceneDetect.aip
 

scripts/bump_installer.py

@@ -15,6 +15,7 @@
     python scripts/bump_installer.py             # version bump only
     python scripts/bump_installer.py --sync-files  # bump + re-sync APPDIR
     python scripts/bump_installer.py --sync-only   # re-sync APPDIR only (CI)
+    python scripts/bump_installer.py --sync-only --dev  # CI dev build (renames MSI)
     python scripts/bump_installer.py --version 0.7.0  # explicit version override
 
 The version-bump path rewrites ProductVersion / ProductCode / PackageFileName.
@@ -25,6 +26,11 @@
 is already at the release version and we just want the file list to match
 CI's pyinstaller output (rather than the developer's local one).
 
+--dev (CI-only, combined with --sync-only) additionally rewrites the MSI
+PackageFileName to PySceneDetect-{ver}-dev-win64.msi so dev-build artifacts
+can't be confused with release artifacts. ProductVersion and ProductCode
+stay untouched - those have to remain stable for upgrade-chain integrity.
+
 All paths shell out to AdvancedInstaller.com so the .aip's invariants
 (line endings, attribute ordering, GUID casing) stay intact. The CLI lives
 under "C:\\Program Files (x86)\\Caphyon\\Advanced Installer ..\\bin\\x86\\".
@@ -109,19 +115,35 @@ def main() -> None:
         action="store_true",
         help="Re-sync APPDIR only; leave version/GUID fields untouched (CI use).",
     )
+    parser.add_argument(
+        "--dev",
+        action="store_true",
+        help=(
+            "Rename the MSI to PySceneDetect-{ver}-dev-win64.msi so dev-build artifacts "
+            "are distinguishable from release artifacts. Only valid with --sync-only."
+        ),
+    )
     parser.add_argument(
         "--version",
         dest="version_override",
         help="MSI version override (default: derived from scenedetect.__version__).",
     )
     args = parser.parse_args()
 
+    if args.dev and not args.sync_only:
+        sys.exit("--dev is only valid in combination with --sync-only.")
+
     advinst = find_advinst()
     print(f"Using {advinst}")
 
     if args.sync_only:
         print(f"Re-syncing APPDIR in {INSTALLER_AIP.name}")
         resync_appdir(advinst)
+        if args.dev:
+            version = msi_version(args.version_override or scenedetect.__version__)
+            dev_name = f"PySceneDetect-{version}-dev-win64.msi"
+            print(f"Renaming MSI package to {dev_name} (dev build)")
+            run(advinst, "/SetPackageName", dev_name, "-buildname", "DefaultBuild")
         return
 
     raw_version = args.version_override or scenedetect.__version__

scripts/pre_release.py

@@ -18,8 +18,12 @@
 import sys
 from pathlib import Path
 
-REPO_DIR = Path(__file__).resolve().parent.parent
+SCRIPTS_DIR = Path(__file__).resolve().parent
+REPO_DIR = SCRIPTS_DIR.parent
 sys.path.insert(0, str(REPO_DIR))
+sys.path.insert(0, str(SCRIPTS_DIR))
+
+from bump_installer import msi_version  # noqa: E402
 
 import scenedetect  # noqa: E402
 
@@ -34,8 +38,15 @@
 
 if run_version_check:
     installer_aip = INSTALLER_AIP.read_text()
-    aip_version = f'<ROW Property="ProductVersion" Value="{VERSION}" Options="32"/>'
-    assert aip_version in installer_aip, f"Installer project version does not match {VERSION}."
+    # The .aip stores the numeric MSI form (e.g. "0.7.0"), not the Python __version__
+    # (which may be "0.7-dev0", "0.7", "0.7.1", ...). Normalize through the same
+    # function bump_installer.py uses to write the .aip so the comparison is apples-to-apples.
+    expected = msi_version(VERSION)
+    aip_row = f'<ROW Property="ProductVersion" Value="{expected}" Options="32"/>'
+    assert aip_row in installer_aip, (
+        f"Installer ProductVersion does not match normalized {VERSION!r} ({expected!r}). "
+        f"Run `python scripts/bump_installer.py` to refresh the .aip."
+    )
 
 with VERSION_INFO.open("wb") as f:
     v = VERSION.split(".")

scripts/stage_windows_dist.py

@@ -69,13 +69,22 @@ def find_7zip() -> Path:
     sys.exit("7-Zip not found. Install from https://www.7-zip.org/.")
 
 
+def _rel(p: Path) -> str:
+    # Display paths relative to the repo when possible, else fall back to the
+    # absolute path (e.g. --ffmpeg-dir pointing outside the repo on CI).
+    try:
+        return str(p.relative_to(REPO_DIR))
+    except ValueError:
+        return str(p)
+
+
 def copy_file(src: Path, dst: Path) -> None:
     if not src.exists():
         print(f"WARNING: {src} missing - skipping {dst.name}")
         return
     dst.parent.mkdir(parents=True, exist_ok=True)
     shutil.copy2(src, dst)
-    print(f"  {src.relative_to(REPO_DIR)} -> {dst.relative_to(REPO_DIR)}")
+    print(f"  {_rel(src)} -> {_rel(dst)}")
 
 
 def stage_ffmpeg(ffmpeg_dir: Path | None) -> None: