ZacharyZhang-NY
740d0812ee
electron-builder's `extraMetadata` feature mutates the source package.json in place during packaging and restores it on clean exit. When the builder is killed mid-flight (parent task timeout, Ctrl-C, OOM) the restore never fires and the source tree is left with a stripped scripts block — every subsequent pnpm command then fails with "Missing script" until someone notices the drift and runs `git checkout`. Observed once in this session when a `build:dir` task was cancelled mid-packaging. Wrap the builder invocation in a bytes-level snapshot + idempotent restore, driven by both normal-exit and SIGINT/SIGTERM/SIGHUP handlers. On a clean run the builder's own restore wrote the original bytes back, our final compare is byte-equal, and the restore is a no-op. On an abnormal termination the snapshot overwrites whatever electron-builder left behind so the working tree is guaranteed clean regardless of exit path. The snapshot approach is intentional over a "reject if tree dirty before build" guard: this is a recovery mechanism, not a precondition, and the repo's own `package.json` is the truth — anything else in there at the moment the builder took its snapshot is the desired state.
scripts/
Build, release, and asset-generation helpers invoked from package.json
or from the release pipeline. Every top-level script has a single owner
and is wired up either as an npm script or as a child of release-boss.mjs.
Layout
| Path | Purpose |
|---|---|
postinstall.mjs |
Ran by pnpm after install; stamps Electron name patches and env dependencies. |
build-desktop.mjs |
pnpm build entry. Wraps electron-builder with AgentCompany defaults. |
build-all-platforms.mjs |
pnpm build:current entry. Cross-platform matrix driver for local testing. |
build/ |
Auxiliary assets consumed by electron-builder (entitlements, installer hooks). |
electron-builder-mac-sign.mjs |
macOS codesign + notarize helper invoked from electron-builder afterSign. |
patch-electron-name.sh |
Rewrites the Electron binary name into AgentCompany so macOS treats it as a distinct app. |
release/ |
Shared helpers imported by release-* scripts. |
release-boss.mjs |
pnpm release:boss entry. Builds the Boss edition bundle and uploads it. |
release-local.mjs |
pnpm release:local entry. Packages a local-only build for internal testers. |
release-local/ |
Fixtures / templates consumed by release-local.mjs. |
release-public-cloudflare.mjs |
pnpm release:cloudflare:public entry. Publishes the public release to Cloudflare R2. |
generate-landing-release-links.mjs |
Regenerates the landing-page download links from the Cloudflare manifest. |
icons/ |
Icon generation utilities. See icons/generate-icons.py. |
Icons
pnpm assets:generate runs scripts/icons/generate-icons.py, a
macOS-only helper that rebuilds the Electron app icon, the landing-page
favicons, and the tray icons from the SVG masters in assets/. Only
re-run it when the SVG sources change; the committed PNG / ICNS outputs
are consumed directly at build time.
Release
pnpm release:cloudflare invokes release-public-cloudflare.mjs
followed by release-boss.mjs. The Boss edition bundles additional
credentials and is uploaded to a private bucket; never commit its
outputs (see the boss-build/ entry in .gitignore).
Conventions
- Scripts here are invoked from CI and from local dev. They must run
without network access except where explicitly required (release
uploads). Any tool requirement (e.g.
cairo,iconutil) belongs in the script's header comment with install instructions. - Treat
scripts/as source, not generated output. Do not commit build artefacts into subdirectories beyond the fixtures underbuild/andrelease-local/.