electron / update-electron-app

🌲 A drop-in module that adds autoUpdating capabilities to Electron apps
MIT License
736 stars 131 forks source link

Documentation doesn't state what assets need to be included in Github Releases #122

Open davidjmeyer opened 1 year ago

davidjmeyer commented 1 year ago

The documentation mentions

For Windows, you'll need to build a .exe file and include it in your GitHub Release.

But this doesn't seem to be sufficient. When I try this I can see in the Squirrel-CheckForUpdate.log that it's trying to download the RELEASES file. It seems that I need to be uploading the -full.nupkg and RELEASES file to every GitHub release.

mepadev commented 8 months ago

Yeah, I agree.

To resolve that and see what is default, I ran the: npm run publish ----> env-cmd electron-forge publish

PS: I use env-cmd because for this to work you need the GITHUB_TOKEN variable. And I like to put this in .env**

After this, I have the three files published as a DRAFT RELEASE on Github: app.exe, app.nupkg, RELEASES

anaisbetts commented 8 months ago

You need to include the RELEASES file and any file it references - Squirrel.Windows is really simple:

  1. Read RELEASES file
  2. Compare versions
  3. Download the files listed in RELEASES file to move from $CURRENT_VERSION => $NEW_VERSION, either all of the deltas between $OLD and $NEW (hopefully just one), or the latest full release