Documented "skipUpdateIcon" option. #202
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
The option `skipUpdateIcon` was not documented, but seems necessary when using `setupIcon` to avoid error messages. I could only find it in a comment buried in a closed issue (#81 (comment)).
README.md
Outdated
| @@ -57,6 +57,7 @@ There are several configuration settings supported: | |||
| | `signWithParams` | No | Params to pass to signtool. Overrides `certificateFile` and `certificatePassword`. | | |||
| | `iconUrl` | No | A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Atom icon. | | |||
| | `setupIcon` | No | The ICO file to use as the icon for the generated Setup.exe | | |||
| | `skipUpdateIcon` | No | When set to true, prevents setupIcon-related error messages "This application could not be started" that may occur during installation. | | |||
There was a problem hiding this comment.
This isn't actually what the skipUpdateIcon option does, it's the effect of enabling the option but it doesn't actually do this. A more appropriate thing to put here would be
Disables setting the icon of `Update.exe`, this can solve startup errors if you are building your application on macOS.
There was a problem hiding this comment.
I'm all for having more accurate documentation, and indeed I focused on the indirect effect rather than the direct one.
However, I never ran/built anything on macOS, so I am not sure that your description is entirely accurate either? Because for sure I needed to enable that option.
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.
The option
skipUpdateIconwas not documented, but seems necessary when usingsetupIconto avoid error messages. I could only find it in a comment buried in a closed issue (#81 (comment)).