Attempt to add script based removal of OpenXR for CI.

Author: Toys0125

.github/scripts/sanitize_headless_ci.py

@@ -18,6 +18,7 @@
 PACKAGE_DEPENDENCIES_TO_REMOVE = (
     "com.llealloo.audiolink",
     "com.unity.xr.openxr",
+    "com.valvesoftware.openxr.utils",
     "com.valvesoftware.unity.openvr",
 )
 
@@ -41,6 +42,11 @@
     "AudioLink",
 )
 
+PACKAGE_LOCK_ENTRIES_TO_REMOVE = PACKAGE_DEPENDENCIES_TO_REMOVE + (
+    "com.basis.openvr",
+    "com.basis.openxr",
+)
+
 
 def normalize_project_path(path: Path, project_root: Path) -> str:
     return path.relative_to(project_root).as_posix()
@@ -100,6 +106,35 @@ def remove_manifest_dependencies(project_root: Path) -> list[str]:
     return removed_dependencies
 
 
+def remove_package_lock_entries(project_root: Path) -> list[str]:
+    lock_path = project_root / "Packages/packages-lock.json"
+    if not lock_path.exists():
+        return []
+
+    import json
+
+    lock_data = json.loads(lock_path.read_text(encoding="utf-8"))
+    dependencies = lock_data.get("dependencies", {})
+    removed_entries: list[str] = []
+
+    for dependency in PACKAGE_LOCK_ENTRIES_TO_REMOVE:
+        if dependencies.pop(dependency, None) is not None:
+            removed_entries.append(dependency)
+
+    for package_info in dependencies.values():
+        package_dependencies = package_info.get("dependencies")
+        if not isinstance(package_dependencies, dict):
+            continue
+
+        for dependency in PACKAGE_LOCK_ENTRIES_TO_REMOVE:
+            package_dependencies.pop(dependency, None)
+
+    if removed_entries:
+        lock_path.write_text(json.dumps(lock_data, indent=2) + "\n", encoding="utf-8")
+
+    return removed_entries
+
+
 def strip_editor_build_settings(project_root: Path) -> list[str]:
     settings_path = project_root / "ProjectSettings/EditorBuildSettings.asset"
     lines = settings_path.read_text(encoding="utf-8").splitlines(keepends=True)
@@ -238,6 +273,12 @@ def main() -> int:
         for dependency in removed_dependencies:
             print(f"  - {dependency}")
 
+    removed_lock_entries = remove_package_lock_entries(project_root)
+    if removed_lock_entries:
+        print(f"Removed {len(removed_lock_entries)} package lock entries from {project_root / 'Packages/packages-lock.json'}")
+        for dependency in removed_lock_entries:
+            print(f"  - {dependency}")
+
     removed_config_keys = strip_editor_build_settings(project_root)
     if removed_config_keys:
         print(f"Removed {len(removed_config_keys)} XR config objects from {project_root / 'ProjectSettings/EditorBuildSettings.asset'}")

.github/scripts/sanitize_linux_client_ci.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+from __future__ import annotations
+
+import json
+import shutil
+import sys
+from pathlib import Path
+
+
+PACKAGE_DIRS_TO_REMOVE = (
+    "Packages/com.basis.openxr",
+    "Packages/com.meta.xr.sdk.core",
+)
+
+PACKAGE_DEPENDENCIES_TO_REMOVE = (
+    "com.unity.xr.openxr",
+    "com.valvesoftware.openxr.utils",
+)
+
+PACKAGE_LOCK_ENTRIES_TO_REMOVE = PACKAGE_DEPENDENCIES_TO_REMOVE + (
+    "com.basis.openxr",
+)
+
+
+def remove_manifest_dependencies(project_root: Path) -> list[str]:
+    manifest_path = project_root / "Packages/manifest.json"
+    manifest = json.loads(manifest_path.read_text(encoding="utf-8"))
+    dependencies = manifest.get("dependencies", {})
+    removed: list[str] = []
+
+    for dependency in PACKAGE_DEPENDENCIES_TO_REMOVE:
+        if dependencies.pop(dependency, None) is not None:
+            removed.append(dependency)
+
+    if removed:
+        manifest_path.write_text(json.dumps(manifest, indent=2) + "\n", encoding="utf-8")
+
+    return removed
+
+
+def remove_package_lock_entries(project_root: Path) -> list[str]:
+    lock_path = project_root / "Packages/packages-lock.json"
+    if not lock_path.exists():
+        return []
+
+    lock_data = json.loads(lock_path.read_text(encoding="utf-8"))
+    dependencies = lock_data.get("dependencies", {})
+    removed: list[str] = []
+
+    for dependency in PACKAGE_LOCK_ENTRIES_TO_REMOVE:
+        if dependencies.pop(dependency, None) is not None:
+            removed.append(dependency)
+
+    for package_info in dependencies.values():
+        package_dependencies = package_info.get("dependencies")
+        if not isinstance(package_dependencies, dict):
+            continue
+
+        for dependency in PACKAGE_LOCK_ENTRIES_TO_REMOVE:
+            package_dependencies.pop(dependency, None)
+
+    if removed:
+        lock_path.write_text(json.dumps(lock_data, indent=2) + "\n", encoding="utf-8")
+
+    return removed
+
+
+def remove_package_dirs(project_root: Path) -> list[Path]:
+    removed: list[Path] = []
+
+    for relative_dir in PACKAGE_DIRS_TO_REMOVE:
+        package_dir = project_root / relative_dir
+        if package_dir.exists():
+            shutil.rmtree(package_dir)
+            removed.append(package_dir)
+        else:
+            print(f"Package directory already absent: {package_dir}")
+
+    return removed
+
+
+def main() -> int:
+    project_root = Path(sys.argv[1]) if len(sys.argv) > 1 else Path("Basis")
+    project_root = project_root.resolve()
+
+    if not project_root.exists():
+        print(f"Project root not found: {project_root}", file=sys.stderr)
+        return 1
+
+    removed_manifest_dependencies = remove_manifest_dependencies(project_root)
+    for dependency in removed_manifest_dependencies:
+        print(f"Removed manifest dependency: {dependency}")
+
+    removed_lock_entries = remove_package_lock_entries(project_root)
+    for dependency in removed_lock_entries:
+        print(f"Removed package lock entry: {dependency}")
+
+    removed_package_dirs = remove_package_dirs(project_root)
+    for package_dir in removed_package_dirs:
+        print(f"Removed package directory: {package_dir}")
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

.github/workflows/compilation.yml

@@ -84,13 +84,11 @@ jobs:
       - name: "Create version string"
         id: version
         run: echo "gitversion=$(git describe --tags --always)" >> "$GITHUB_OUTPUT"
-      - name: "Remove OpenXR when building for Linux"
+      - name: "Sanitize Linux client project"
         if: matrix.targetPlatform == 'StandaloneLinux64'
-        run: rm -rf ${projectPath}/Packages/com.basis.openxr
-        # run: jq 'del(.dependencies ["com.unity.xr.openxr"])' < ${projectPath}/Packages/manifest.json > manifest.json.tmp && mv manifest.json.tmp ${projectPath}/Packages/manifest.json
-      - name: "Remove Meta XR Core when building for Linux"
-        if: matrix.targetPlatform == 'StandaloneLinux64'
-        run: rm -rf ${projectPath}/Packages/com.meta.xr.sdk.core
+        shell: bash
+        run: |
+          python3 .github/scripts/sanitize_linux_client_ci.py "${projectPath}"
       # Fix docker not ready on windows
       - name: Ensure Docker service is running
         if: matrix.buildPlatform == 'windows-2022'