CI: cache package Electron native rebuild outputs#23274
Open
Sewer56 wants to merge 6 commits into
Open
Conversation
Move @vortex/main postinstall into a small Node wrapper so CI workflows can opt out of or defer electron-rebuild with explicit environment variables. This commit does not change CI timing by itself: without VORTEX_SKIP_ELECTRON_REBUILD or VORTEX_DEFER_ELECTRON_REBUILD, postinstall still runs pnpm exec electron-rebuild. The wrapper also uses shell=true on Windows so spawned pnpm resolves correctly in packaged install flows. The follow-up optimization PRs use these controls independently: format skips rebuild, main defers rebuild to a cached explicit step, and package skips the deployed dist postinstall before restoring/rebuilding packaged native outputs.
Sewer56
force-pushed
the
ci/opt-package-native-cache
branch
2 times, most recently
from
5e84e4a to
ae8af8a
Compare
IDCs
previously approved these changes
May 21, 2026
Replace VORTEX_SKIP_ELECTRON_REBUILD and VORTEX_DEFER_ELECTRON_REBUILD with VORTEX_ELECTRON_REBUILD accepting "skip" or "defer" (default: run). Both flags had identical behavior (exit 0), differing only in log message.
Split the shared package composite action so packaged electron-rebuild outputs can use a dedicated actions/cache entry. This action is used by both package.yml and nightly.yml. This branch is based on the separate Electron rebuild controls PR. Controls alone do not optimize package.yml; this commit owns the package behavior changes: - install dependencies with VORTEX_ELECTRON_REBUILD=defer - cache native build headers - build the workspace without running a workspace Electron native rebuild - publish src/main/dist with VORTEX_ELECTRON_REBUILD=skip - restore/cache packaged native outputs under src/main/dist/node_modules - explicitly rebuild packaged native modules in src/main/dist - run electron-builder packaging from src/main Only the packaged/dist native output cache is needed. An initial version cached both workspace node_modules/.pnpm outputs and packaged src/main/dist/node_modules outputs, but probe runs on Sewer56/Vortex showed the workspace Electron rebuild/cache is not required for package.yml to build successfully. Removing the workspace rebuild/cache still passed publish and installer packaging. The packaged/dist cache is still required. pnpm deploy creates src/main/dist/node_modules from the content-addressable store and dist virtual store, so it does not preserve Electron-rebuilt workspace virtual-store outputs. Cold/no-hit dist-cache-only probe still passed, but spent about 97s from the packaged cache step to the installer step: - https://github.com/Sewer56/Vortex/actions/runs/26091864064 The original two-cache warmup spent about 67s in the packaged rebuild before the packaged cache existed: - https://github.com/Sewer56/Vortex/actions/runs/26067243939 Warm packaged cache hits reduce that rebuild path to about 1-2s. The explicit dist rebuild calls node ./node_modules/@electron/rebuild/lib/cli.js instead of pnpm --dir src/main/dist exec electron-rebuild because pnpm exec in the deployed dist package can try dependency resolution there and fail on peer-suffixed specs. Calling the installed CLI directly avoids that resolver path. Baseline package.yml runs before this optimization: - https://github.com/Sewer56/Vortex/actions/runs/26065180899 - https://github.com/Sewer56/Vortex/actions/runs/26065183051 - https://github.com/Sewer56/Vortex/actions/runs/26065185231 Package Vortex median was 814s. Original two-cache measured runs: - https://github.com/Sewer56/Vortex/actions/runs/26067806598 - https://github.com/Sewer56/Vortex/actions/runs/26067807434 - https://github.com/Sewer56/Vortex/actions/runs/26067808289 Package Vortex median was 642s (-172s vs baseline). Dist-cache-only warm measured runs: - https://github.com/Sewer56/Vortex/actions/runs/26092460250 - https://github.com/Sewer56/Vortex/actions/runs/26093157889 - https://github.com/Sewer56/Vortex/actions/runs/26093159302 Package Vortex median was 633s (-181s vs baseline). Packaged native cache hit on all warm measured runs. Cleaned-stack validation after rebase: - https://github.com/Sewer56/Vortex/actions/runs/26099063004 - https://github.com/Sewer56/Vortex/actions/runs/26099063777 - https://github.com/Sewer56/Vortex/actions/runs/26100726058 - https://github.com/Sewer56/Vortex/actions/runs/26115728616 - https://github.com/Sewer56/Vortex/actions/runs/26115728667 These runs succeeded with packaged cache hit true where measured. Package Vortex steps were 685s, 649s, and 661s in the first three validation runs.
pnpm --dir src/main run package works but is fragile - breaks silently if the directory moves. pnpm -F @vortex/main is the idiomatic workspace filter that resolves the same script by package name. Semantically equivalent: both run only the 'package' script without dependency resolution, preserving the native rebuild optimization. Using pnpm nx run would be WRONG here - it resolves the dependency chain (package -> publish -> rimraf ./dist), destroying the native rebuilds.
- Replace pnpm --dir with pnpm -F for package/package:nosign scripts (--dir breaks silently if directory moves; -F uses package name) - Guard native rebuild on cache miss (skip @electron/rebuild entirely when packaged-native-cache hits, instead of running unconditionally for a wasteful tree scan) - Use npx electron-rebuild instead of direct node path (pnpm exec fails in dist/ with LOCKFILE_CONFIG_MISMATCH since deployed dist has no pnpm workspace context; npx resolves from node_modules/.bin without pnpm's lockfile validation)
Sewer56
force-pushed
the
ci/opt-package-native-cache
branch
from
ae8af8a to
f87cbd5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of LAZ-411
Depends on:
This is package-specific version of:
Summary
Cache Electron native rebuild outputs in the shared package composite action.
Because change is in
.github/actions/package/action.yml, both workflows benefit:package.ymlnightly.ymlChange
Package action now:
VORTEX_DEFER_ELECTRON_REBUILD=1, then builds Vortexsrc/main/distwithVORTEX_SKIP_ELECTRON_REBUILD=1; native modules are skipped throughoutsrc/main/dist/node_modules; cache hit means skip rebuildnpx electron-rebuild(native build headers are also cached to speed this up)Cache keys are derived from
pnpm-lock.yaml,pnpm-workspace.yaml,src/main/package.json, andsrc/main/postinstall.mjsso dependency bumps invalidate correctly.Cache miss behaviour
On cache miss,
actions/cacherestores nothing andelectron-rebuildruns a full rebuild, identical to baseline. Cache populates on first run; subsequent runs hit. GitHub evicts stale caches automatically.Measurement
Baseline package runs before this optimisation:
Dist-cache-only warm measured runs:
Result:
Package Vortexmedian:832s → 651s(-181s)