[icons] Use buildResources folder #771
Merged
Conversation
This file contains 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
loremattei
approved these changes
Feb 11, 2020
nsakaimbo
added a commit
that referenced
this pull request
Feb 26, 2020
### Changes include: * [notarization] Revert workaround for buggy after\_sign\_hook (#782) * [icons] Use buildResources folder (#771) Updates the application icon folder structure and declarations to be aligned with updated electron-builder documentation. Specifically, we streamline the usage of application icons by: - Removing direct icon references for each platform in package.json, and replacing with a top-level buildResources directory - Removing the linux-specific icon so electron-builder can use icon.icns for both Linux and Mac (per the docs) Per the docs, icons in buildResources will automatically be detected and used accordingly as follows: - icon.icns -- Mac and Linux (installers and applications) - background.png and [email protected] (Mac installer backgrounds) - icon.ico -- Windows (installer and application)
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.
Use buildResources Folder for App Icons
This PR updates the application icon folder structure and declarations to be aligned with updated
electron-builderdocumentation. Specifically, we streamline the usage of application icons by:iconreferences for each platform in package.json, and replacing with abuildResourcesdirectory insteadelectron-buildercan useicon.icnsfor both Linux and Mac (per the docs)Per the docs, icons in
buildResourceswill automatically be detected and used accordingly as follows:icon.icns-- Mac and Linux (installers and applications)background.pngand[email protected](Mac DMG backgrounds)icon.ico-- Windows (installer and application)I have tested the built artifacts on all platforms and confirmed the icons are used as expected. 🎉 The end-result is we have fewer assets to track and update on an ongoing basis, with the added benefit of allowing
electron-builderto do the heavy lifting without explicit references inpackage.json.In addition, specifying the icons this way may mitigate the symptom of "icon caching" (ref), where the new application icon is not used until a system restart. (Confirmed this is due to behavior at the system level and not an Electron-specific quirk).