[build] Allow building development .msi artifacts

Author: Breakthrough

RELEASE-PLAN.md

@@ -43,6 +43,7 @@ Version referenced below as `X.Y[.Z]` - replace with the real version throughout
 - [ ] `python scripts/pre_release.py --release` passes (enforces `.aip` ↔ `__version__` parity, writes `packaging/windows/.version_info`).
 - [ ] `pyinstaller packaging/windows/scenedetect.spec` produces a working `scenedetect.exe` - run it against a sample video.
 - [ ] `python scripts/stage_windows_dist.py --ffmpeg-dir <dir> --portable-zip` populates `dist/scenedetect/` with ffmpeg, third-party licenses, sphinx docs, and emits the portable `.zip`. Pass `--ffmpeg-dir` pointing at a recent extracted [GyanD codexffmpeg](https://github.com/GyanD/codexffmpeg/releases) build; omit it only for offline builds (uses the bundled `packaging/windows/thirdparty.7z` with a stub `LICENSE-FFMPEG`).
+- [ ] `python scripts/bump_installer.py --sync-files` and commit the .aip diff (refreshes the APPDIR baseline so CI's per-build `--sync-only` diff stays small).
 - [ ] Build the MSI via Advanced Installer (`packaging/windows/installer/PySceneDetect.aip`); install into a clean Windows VM and run the CLI.
 - [ ] After both `pyinstaller` and the MSI build are done (and the portable `.zip` is staged at `dist/PySceneDetect-X.Y.Z-portable.zip`), run `python scripts/generate_manifest.py` to produce `dist/PySceneDetect-X.Y.Z.manifest.json` (per-file SHA256 audit of every artifact) and `dist/SHA256SUMS` (flat `sha256sum -c` compatible). Both are attached to the GitHub release in step 7.
 

appveyor.yml

@@ -64,15 +64,26 @@ install:
   - appveyor-tools\secure-file -decrypt license65.dat.enc -secret %ai_license_secret% -salt %ai_license_salt%
   - appveyor DownloadFile https://www.advancedinstaller.com/downloads/advinst.msi
   - msiexec /i advinst.msi /qn
-  - 'SET PATH=%PATH%;C:\\Program Files (x86)\\Caphyon\\Advanced Installer 22.9.1\\bin\\x86'
+  # Resolve the installed Advanced Installer bin path dynamically - the upstream
+  # MSI is unversioned so the directory name (Advanced Installer X.Y.Z) drifts.
+  - ps: $aiBin = (Get-ChildItem 'C:\Program Files (x86)\Caphyon\Advanced Installer*\bin\x86' | Sort-Object FullName -Descending | Select-Object -First 1).FullName; Add-Content $env:APPVEYOR_BUILD_FOLDER\ai_path.txt $aiBin
+  - set /p AI_BIN=<%APPVEYOR_BUILD_FOLDER%\ai_path.txt
+  - 'SET PATH=%PATH%;%AI_BIN%'
   # License path must be absolute
   - AdvancedInstaller.com /RegisterOffline "%cd%\license65.dat"
   - cd ../../..
   # Re-sync APPDIR from CI's dist/scenedetect (handles drift between local and
   # 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)
+  # Snapshot the post-sync .aip and the actual payload tree as build artifacts.
+  # The committed .aip is a baseline; CI adapts it to its own pyinstaller output
+  # and we never write back to git, so these snapshots are the authoritative
+  # record of what each MSI was built from (for audit / release forensics).
+  - copy packaging\windows\installer\PySceneDetect.aip dist\PySceneDetect.aip
   # Create MSI installer
   - AdvancedInstaller.com /build packaging/windows/installer/PySceneDetect.aip
 
@@ -112,3 +123,8 @@ artifacts:
   # MSI Installer + .EXE Bundle for Signing
   - path: dist/scenedetect-signed.zip
     name: PySceneDetect-win64_installer
+  # Build provenance: post-sync .aip and the portable payload manifest.
+  - path: dist/PySceneDetect.aip
+    name: PySceneDetect-build-manifest-aip
+  - path: dist/PySceneDetect-*-portable.manifest.txt
+    name: PySceneDetect-build-manifest-payload

scripts/bump_installer.py

@@ -12,23 +12,18 @@
 """Bump the AdvancedInstaller .aip project for a release.
 
 Usage:
-    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 --version 0.7.0  # explicit version override
-
-The version-bump path rewrites ProductVersion / ProductCode / PackageFileName.
---sync-files additionally walks dist/scenedetect/ (pyinstaller output) and
-rewrites the project's directory + component + file tables to match, which
-is needed when bundled dependencies change. --sync-only does the resync
-without touching version/identity fields - intended for CI, where the .aip
-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).
-
-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\\".
-Override discovery with the ADVINST environment variable.
+    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 committed .aip is a baseline; CI's --sync-only adapts it per build and is
+never written back to git. Refresh locally with --sync-files before each release.
+
+All paths shell out to AdvancedInstaller.com to preserve .aip invariants
+(line endings, attribute ordering, GUID casing). Override CLI discovery with
+the ADVINST environment variable.
 """
 
 import argparse
@@ -109,19 +104,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:
@@ -141,13 +150,20 @@ def stage_thirdparty_licenses() -> None:
 
 def make_portable_zip(version: str) -> None:
     zip_path = DIST_DIR / f"PySceneDetect-{version}-portable.zip"
+    manifest_path = DIST_DIR / f"PySceneDetect-{version}-portable.manifest.txt"
     if zip_path.exists():
         zip_path.unlink()
     print(f"Creating {zip_path.relative_to(REPO_DIR)}...")
+    files = sorted(p for p in DIST_TREE.rglob("*") if p.is_file())
     with zipfile.ZipFile(zip_path, "w", zipfile.ZIP_DEFLATED) as zf:
-        for path in sorted(p for p in DIST_TREE.rglob("*") if p.is_file()):
+        for path in files:
             zf.write(path, path.relative_to(DIST_TREE))
     print(f"  {zip_path.stat().st_size / (1024 * 1024):.1f} MB")
+    manifest_path.write_text(
+        "\n".join(str(p.relative_to(DIST_TREE)) for p in files) + "\n",
+        encoding="utf-8",
+    )
+    print(f"  manifest -> {manifest_path.relative_to(REPO_DIR)}")
 
 
 def main() -> None: