docs: remove osxSign.binaries from JSDoc (intentionally unsupported)#1930
Merged
Conversation
The osxSign JSDoc still advertised a `binaries` sub-option, even though packager intentionally strips it before calling @electron/osx-sign (see issue #285) and the PackagerOsxSignOptions type already omits it. TypeDoc publishes this JSDoc to the API docs site, producing the contradiction reported in #1723. Replace the bullet with a note explaining the real behavior: binaries physically present in the bundle (including app.asar.unpacked) are signed automatically, and native modules packed inside app.asar should be unpacked so they can be signed. Also extend the runtime warning in src/mac.ts with the same guidance. Refs #1723 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BVhUtw4HMUepasMThQXycP
MarshallOfSound
approved these changes
Jul 3, 2026
MarshallOfSound
marked this pull request as ready for review
July 3, 2026 19:30
erickzhao
approved these changes
Jul 7, 2026
claude
Bot
force-pushed
the
fix-osxsign-binaries-jsdoc
branch
from
July 7, 2026 18:13
f8d343b to
27d722b
Compare
MarshallOfSound
approved these changes
Jul 7, 2026
erickzhao
enabled auto-merge (squash)
July 7, 2026 19:18
|
🎉 This PR is included in version 20.0.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
3 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.
Requested by Samuel Attard · Slack thread
build:docsrun clean; behavior is unchanged)Summarize your changes:
Before: the published API docs (generated by TypeDoc from the
osxSignJSDoc insrc/types.ts) advertise abinariessub-option, but packager intentionally stripsbinariesat runtime before handing options to@electron/osx-sign(a decision dating back to #285), and thePackagerOsxSignOptionstype alreadyOmits it. So the docs promise an option that TypeScript rejects and the runtime silently discards.After: the docs describe the real behavior — binaries physically present in the packaged app (including anything under
app.asar.unpacked) are automatically discovered and signed by@electron/osx-sign, and native modules packed insideapp.asarshould be unpacked (via theasarunpackoption or Electron Forge'sAutoUnpackNativesPlugin) so they can be signed.How: removed the
binariesbullet from theosxSignJSDoc insrc/types.tsand replaced it with a note explaining the intentional omission (linking #285) and the recommended approach. Also extended the existing runtime warning insrc/mac.ts(thesignOpts.binariesstrip) with the same one-sentence guidance so users who hit it at runtime know what to do instead.Addresses the docs contradiction reported in #1723 — leaving it to maintainers whether this fully closes it. Refs #1723.
🤖 Generated with Claude Code
https://claude.ai/code/session_01BVhUtw4HMUepasMThQXycP
Generated by Claude Code