chore(ci): add Meta Spatial Editor CLI setup for GLXF generation in CI builds

Summary: Download and configure Meta Spatial Editor CLI in build-examples.sh for Linux/CI environments only (skipped on macOS). Pass CLI path to generateGLXF plugin via META_SPATIAL_EDITOR_CLI_PATH env var. Also upgrades pnpm to v10 in deploy workflow and adds --no-frozen-lockfile flag only when running in CI.

Reviewed By: zjm-meta

Differential Revision:
D90213384

Privacy Context Container: L1334777

fbshipit-source-id: a8ab6be27685bcfc430ae79ebf1c809714d68cab

Author: felixtrz

.github/workflows/deploy-docs.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v2
         with:
-          version: 8
+          version: 10
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -39,7 +39,7 @@ jobs:
         uses: actions/configure-pages@v4
 
       - name: Install dependencies
-        run: pnpm install --no-frozen-lockfile
+        run: pnpm install
 
       - name: Build documentation
         run: pnpm docs:build

.gitignore

@@ -89,3 +89,6 @@ example-local-build/**/public/ui/
 # Auto generated version files
 **/version.ts
 **/version.js
+
+# Meta Spatial Editor CLI (downloaded by build-examples.sh in CI)
+.meta-spatial-cli/

examples/audio/vite.config.js

@@ -41,6 +41,9 @@ export default defineConfig({
 
     // GLXF generation plugin with file watcher
     generateGLXF({
+      ...(process.env.META_SPATIAL_EDITOR_CLI_PATH && {
+        metaSpatialCliPath: process.env.META_SPATIAL_EDITOR_CLI_PATH,
+      }),
       metaSpatialDir: 'metaspatial',
       outputDir: 'public/glxf', // Match the manual CLI test output
       verbose: false,

examples/grab/vite.config.js

@@ -41,6 +41,9 @@ export default defineConfig({
 
     // GLXF generation plugin with file watcher
     generateGLXF({
+      ...(process.env.META_SPATIAL_EDITOR_CLI_PATH && {
+        metaSpatialCliPath: process.env.META_SPATIAL_EDITOR_CLI_PATH,
+      }),
       metaSpatialDir: 'metaspatial',
       outputDir: 'public/glxf', // Match the manual CLI test output
       verbose: false,

examples/locomotion/vite.config.js

@@ -33,6 +33,9 @@ export default defineConfig({
 
     // GLXF generation plugin with file watcher
     generateGLXF({
+      ...(process.env.META_SPATIAL_EDITOR_CLI_PATH && {
+        metaSpatialCliPath: process.env.META_SPATIAL_EDITOR_CLI_PATH,
+      }),
       metaSpatialDir: 'metaspatial',
       outputDir: 'public/glxf', // Match the manual CLI test output
       verbose: false,

examples/physics/vite.config.js

@@ -40,6 +40,9 @@ export default defineConfig({
 
     // GLXF generation plugin with file watcher
     generateGLXF({
+      ...(process.env.META_SPATIAL_EDITOR_CLI_PATH && {
+        metaSpatialCliPath: process.env.META_SPATIAL_EDITOR_CLI_PATH,
+      }),
       metaSpatialDir: 'metaspatial',
       outputDir: 'public/glxf', // Match the manual CLI test output
       verbose: false,

examples/scene-understanding/vite.config.js

@@ -40,6 +40,9 @@ export default defineConfig({
 
     // GLXF generation plugin with file watcher
     generateGLXF({
+      ...(process.env.META_SPATIAL_EDITOR_CLI_PATH && {
+        metaSpatialCliPath: process.env.META_SPATIAL_EDITOR_CLI_PATH,
+      }),
       metaSpatialDir: 'metaspatial',
       outputDir: 'public/glxf', // Match the manual CLI test output
       verbose: false,

scripts/build-examples.sh

@@ -13,6 +13,50 @@ BASE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
 EXAMPLES_DIR="$BASE_DIR/examples"
 DOCS_EXAMPLES_DIR="$BASE_DIR/docs/.vitepress/dist/examples"
 
+# Download and setup Meta Spatial Editor CLI for Linux (CI only)
+if [[ "$(uname)" == "Linux" ]]; then
+    CLI_DIR="$BASE_DIR/.meta-spatial-cli"
+    CLI_URL="https://securecdn-sjc6-1.oculus.com/binaries/download/?id=32756129430698033"
+
+    echo "📥 Downloading Meta Spatial Editor CLI..."
+    mkdir -p "$CLI_DIR"
+    cd "$CLI_DIR"
+
+    if ! curl -L -o meta-spatial-cli.tar.gz "$CLI_URL"; then
+        echo "❌ Failed to download CLI"
+        exit 1
+    fi
+
+    echo "📦 Extracting CLI..."
+    if ! tar -xzf meta-spatial-cli.tar.gz; then
+        echo "❌ Failed to extract CLI"
+        exit 1
+    fi
+
+    # Make CLI executable
+    chmod +x meta-spatial-editor-cli-linux-dist/MetaSpatialEditorCLI
+    chmod +x meta-spatial-editor-cli-linux-dist/meta-spatial-editor-cli
+
+    CLI_PATH="$CLI_DIR/meta-spatial-editor-cli-linux-dist/MetaSpatialEditorCLI"
+
+    # Verify CLI works
+    echo "🔍 Verifying CLI installation..."
+    if ! "$CLI_PATH" version; then
+        echo "❌ CLI verification failed"
+        exit 1
+    fi
+
+    echo "✅ CLI ready at: $CLI_PATH"
+    echo ""
+
+    # Export CLI path for use in builds
+    export META_SPATIAL_EDITOR_CLI_PATH="$CLI_PATH"
+
+    cd "$BASE_DIR"
+else
+    echo "⏭️  Skipping Meta Spatial Editor CLI download (non-Linux environment)"
+fi
+
 # Track build results
 FAILED_EXAMPLES=()
 SUCCESS_COUNT=0

scripts/build-tgz.sh

@@ -11,6 +11,13 @@ set -e
 
 echo "🚀 Building standalone tgz packages..."
 
+# Detect CI environment and set pnpm install flags
+PNPM_INSTALL_FLAGS=""
+if [ -n "$CI" ] || [ -n "$GITHUB_ACTIONS" ]; then
+    echo "🔍 CI environment detected, using --no-frozen-lockfile"
+    PNPM_INSTALL_FLAGS="--no-frozen-lockfile"
+fi
+
 BASE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
 UNAME=$(uname)
 if [[ "$UNAME" == CYGWIN* || "$UNAME" == MINGW* ]]; then
@@ -144,7 +151,7 @@ build_root_packages() {
 
         # Install the file dependencies
         echo "   📥 Installing file dependencies..."
-        pnpm install
+        pnpm install $PNPM_INSTALL_FLAGS
 
         # Clean and build
         rm -rf lib dist build *.tgz
@@ -164,7 +171,7 @@ build_root_packages() {
         # Restore original package.json and reinstall workspace dependencies
         echo "   🔄 Restoring workspace dependencies..."
         restore_package_json "$package_dir"
-        pnpm install --silent
+        pnpm install --silent $PNPM_INSTALL_FLAGS
     done
 }
 
@@ -178,7 +185,7 @@ cleanup() {
         if [ -f "$package_dir/package.json.backup" ]; then
             restore_package_json "$package_dir"
             cd "$package_dir"
-            pnpm install --silent
+            pnpm install --silent $PNPM_INSTALL_FLAGS
         fi
     done
 }