Add option for including release notes in update dialog

[davej]

Just wondering if showing the release notes when prompting the user to restart is on the roadmap? Release notes would be taken from the github release.

Here's a potential mock-up with a toggle to show/hide:

An option could toggle whether to show them or not:

require('update-electron-app')({
  repo: 'ummoji/ummoji-desktop',
  releaseNotes: true
})

Even if release notes are turned on they would only be shown if there are actually release notes associated with the release. The release notes would probably need to be contained with a maximum height and overflow content should scroll because otherwise the height of the dialog may be too large. Perhaps this should be configurable or perhaps not.

[zeke]

@davej I'm in favor of this. Do you want to give it a try?

[davej]

@zeke Ok, I could have a go at the JavaScript stuff. I think the collapsible release notes would require changes to Electron core and some C code though. Any tips on that? Or perhaps there's a way to approach it without touching Electron core?

[davej]

Windows also has the concept of collapsible text in a dialog. Perhaps this would be a useful addition to Electron core? It's much nicer UX than plonking all the release notes inline on a dialog. Is it worth me opening an issue on Electron Core?

[zeke]

Or perhaps there's a way to approach it without touching Electron core?

Yeah that would be ideal. Since this is designed for use with GitHub Release, we could also offer the user a link to the release page... 🤔

@MarshallOfSound @zcbenz is there a way to know at app startup that the app itself was recently updated? Don't see a hook for that in the autoUpdater docs.

[zcbenz]

@MarshallOfSound @zcbenz is there a way to know at app startup that the app itself was recently updated? Don't see a hook for that in the autoUpdater docs.

The native auto-update frameworks used in Electron do not provide the functionality, it is usually implemented in apps by storing current version in a configuration file.

[sindresorhus]

electron/electron#12437 would make this easier to implement.

[erickzhao]

Ref: electron/electron#23692

Not exactly the toggle, but definitely and improved experience

[jhaemin]

No more updates?