electron-archive / grunt-electron-installer

Grunt plugin to build Windows installers for Electron apps
MIT License
398 stars 106 forks source link

How to attach release notes for electron's autoUpdater? #86

Open plrthink opened 8 years ago

plrthink commented 8 years ago

How to attach release notes? Do we have this feature now? Though it says release notes is not available for windows in electron's autoUpater docs, but I do find the code in electron's repo which get release notes from a json outputed by Squirrel.Windows at this line:

{releaseNotes, version} = update

and I find following lines seems like a test file (Sorry I'm not sure because I have no previous knowledge on Windows development) in Squirrel.Windows:

<releaseNotes>
## Release Notes for 1.1

1. Did some cool stuff
1. Did another thing
1. Did a third thing, pretty crazy!

Make *sure* to refrobulate the confabulator or **terrible things will happen!**
</releaseNotes>

So, if we don't support attach release notes for updates yet, is it possible to add a releaseNotes field to template.nuspec at root folder of this repo and replace its content when building a NuGet package? Or it has already supported this but I can't find that?

plrthink commented 8 years ago

I have tried this idea it works but since Squirrel.Windows parse the release notes as markdown to html, the generated notes would have a bunch of html tags. It's fine for populate a browser window to user with the html text, but I'm using electron's dialog module to notify users there's a update and it can't pares html content. Any ideas?

havenchyk commented 8 years ago

@plrthink have you solved this problem? Maybe it makes sense to add the info to readme, what do you think?