docs(config): document extraResource for runtime assets#258
Open
SAY-5 wants to merge 1 commit into
Open
Conversation
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
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.
Refs electron/forge#3621.
The Electron Packager config page lists
packagerConfigand links to the Packager API docs, but does not show how to ship runtime assets (e.g. a tray icon, native binary, or other file referenced at runtime). Issue #3621 is exactly this case: a tray icon loads inelectron-forge startbut fails after packaging because the file is insideapp.asar. The fix isextraResourceplusprocess.resourcesPath, which is non-obvious without prior knowledge.Adds a hint block under the
Electron Packager configsection with a minimalextraResourceexample and the matching tray-icon main-process snippet that resolves the path withprocess.resourcesPathwhenapp.isPackaged.Maintainer endorsement on the issue (after a contributor offered to write this doc):