You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -266,12 +266,17 @@ Built-in auto-update functionality using `electron-updater`:
266
266
-**Background downloads** with progress tracking
267
267
-**GitHub Releases integration** - fetches updates from repository releases
268
268
-**Platform-specific implementations:**
269
-
- Windows: NSIS installer with differential downloads
270
-
- macOS: DMG with code signing support
269
+
- Windows: NSIS installer with differential downloads (auto-update works on Windows without code signing)
270
+
- macOS: DMG with code signing support. **Important:** macOS requires code signing and notarization for standard auto-update via the ecosystem. This project includes a **custom macOS auto-update implementation** (using built-in Node.js modules) so an update workflow can work without `electron-builder` code signing if you need it. If you prefer the standard signed macOS flow, use `electron-builder` and configure macOS code signing/notarization.
271
271
- Linux: AppImage
272
272
-**Update notifications** with system tray integration
273
273
-**Manual update checks** via application menu
274
274
275
+
### Code signing notes 🔐
276
+
277
+
-**Windows:** We use `electron-builder` for Windows builds. Windows auto-update can work without code signing, so signing is optional; however, if you want signed installers, configure a Windows code signing certificate and set it in your `electron-builder` configuration.
278
+
-**macOS:** Official macOS auto-update and distribution typically requires proper code signing and notarization. This boilerplate provides a custom macOS auto-update (not relying on `electron-builder`) to support update flows without signing. If you need code-signed macOS builds and standard auto-update behavior, configure `electron-builder` and supply the appropriate Apple Developer certificates and notarization settings.
1. Create a **GitHub Personal Access Token** with `repo` scope
549
-
2. Add it to repository secrets as `GITHUB_TOKEN` (automatically provided by GitHub Actions)
553
+
1. Create a **GitHub Personal Access Token** (PAT). For private repositories you need the `repo` scope; for public-only publishing `public_repo` may be sufficient.
554
+
2. In your GitHub repository go to **Settings → Secrets and variables → Actions** and add the token as a secret (common name: `GH_TOKEN`). Note: GitHub Actions also provides an automatically-generated `GITHUB_TOKEN` for workflows, but for publishing from private repositories or when workflows need elevated permissions, you should use a PAT stored as a secret.
555
+
3. If your production build or publish scripts need access to the token at runtime, also add `GH_TOKEN` to your `.env.production` (do **not** commit this file). Keep tokens secret and never hardcode them in your repository.
0 commit comments