7be2386a5f
* fix: trigger ShipIt Mach service to unblock on-demand-only mode When a macOS system update is pending, launchd puts the user domain into on-demand-only mode, preventing ShipIt from starting. The MachServices endpoint in the job dictionary was registered but never connected to (a leftover from the XPC removal in 2013). Instead of removing MachServices, fire a lightweight XPC connection to the Mach port after SMJobSubmit. This satisfies launchd's on-demand trigger, starting ShipIt immediately while preserving KeepAlive retry behavior. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com> Co-authored-by: Keeley Hammond <khammond@slack-corp.com> * fix: add ResetAtClose to ShipIt MachServices to prevent standing demand The XPC trigger message sent after SMJobSubmit sits in the Mach port's kernel queue unread. Without ResetAtClose, this creates standing demand that causes launchd to respawn ShipIt after a successful exit(0), defeating KeepAlive.SuccessfulExit = NO. Set ResetAtClose on the MachServices registration so launchd tears down and recreates the port when ShipIt exits, flushing the stale trigger. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com> Co-authored-by: Keeley Hammond <khammond@slack-corp.com> * fix: drain Mach port before exit(0) instead of using ResetAtClose ResetAtClose blocks KeepAlive.SuccessfulExit retries in on-demand-only mode because it removes demand when the port resets. Instead, have ShipIt drain its own Mach service port (via bootstrap_check_in + mach_msg) before each exit(EXIT_SUCCESS). This clears the standing demand from the trigger message so launchd won't respawn after a successful exit, while leaving the message in place on failure exits so KeepAlive retries remain demand-backed. Tested in on-demand-only mode (pending macOS update): - exit(0) + drain: 1 run, no respawn ✓ - exit(1) + no drain: continuous respawn every 2s ✓ Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com> Co-authored-by: Keeley Hammond <khammond@slack-corp.com> * chore: update patch Co-authored-by: Keeley Hammond <khammond@slack-corp.com> * chore: harden ShipIt Mach trigger and simplify port drain Scope the XPC trigger to the unprivileged path and add a send barrier so the connection cannot be released before the message is on the wire. Reduce drainMachServicePort to bootstrap_check_in (process exit flushes the queue), dropping the mach_msg loop whose buffer/dealloc usage was incorrect, and remove the no-op drain from the posix_spawn'd launch helper. Patch filename regenerated to match the commit subject. Co-authored-by: Samuel Attard <sattard@anthropic.com> * fix: restore explicit mach_msg drain in drainMachServicePort bootstrap_check_in alone does not prevent respawn: launchd tracks outstanding demand independently of the receive right's lifetime, so the queued trigger message must be explicitly dequeued with mach_msg before exit(0). Verified empirically (check-in-only: 5 respawns in 10s; full drain: 1 run). Keep the correctness fixes from the previous commit (4K buffer, mach_msg_destroy on each receive, no mach_port_deallocate). Co-authored-by: Samuel Attard <sattard@anthropic.com> --------- Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Keeley Hammond <khammond@slack-corp.com> Co-authored-by: Samuel Attard <sattard@anthropic.com>
📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project.
The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Visual Studio Code and many other apps.
Follow @electronjs on Twitter for important announcements.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.
Installation
To install prebuilt Electron binaries, use npm.
The preferred method is to install Electron as a development dependency in your
app:
npm install electron --save-dev
For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.
Platform support
Each Electron release provides binaries for macOS, Windows, and Linux.
- macOS (Monterey and up): Electron provides 64-bit Intel and Apple Silicon / ARM binaries for macOS.
- Windows (Windows 10 and up): Electron provides
ia32(x86),x64(amd64), andarm64binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 was removed in Electron 23, in line with Chromium's Windows deprecation policy. - Linux: The prebuilt binaries of Electron are built on Ubuntu 22.04. They have also been verified to work on:
- Ubuntu 18.04 and newer
- Fedora 32 and newer
- Debian 10 and newer
Electron Fiddle
Use Electron Fiddle
to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and
to try out different versions of Electron. It's designed to make the start of your journey with
Electron easier.
Resources for learning Electron
- electronjs.org/docs - All of Electron's documentation
- electron/fiddle - A tool to build, run, and package small Electron experiments
- electronjs.org/community#boilerplates - Sample starter apps created by the community
Programmatic usage
Most people use Electron from the command line, but if you require electron inside
your Node app (not your Electron app) it will return the file path to the
binary. Use this to spawn Electron from Node scripts:
const electron = require('electron')
const proc = require('node:child_process')
// will print something similar to /Users/maf/.../Electron
console.log(electron)
// spawn Electron
const child = proc.spawn(electron)
Mirrors
See the Advanced Installation Instructions to learn how to use a custom mirror.
Documentation translations
We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.
Contributing
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
Community
Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on the Community page.
License
When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.