electron-updater Support for private Github repository

[AlienHoboken]

electron-builder version: 13.7.0:

electron-updater version: 1.6.4

Target Windows:

Electron updater seems unable to locate my private Github repository even when the GH_TOKEN environment variable is set. I've tried setting the env variable through the system settings, programatically by altering process.env.GH_TOKEN, and even passing the token parameter in app-update.yml (which seems it might be respected after looking into electron-updater's code). I've verified via logging that process.env.GH_TOKEN is properly set to my token which has all permission scopes granted.

Is there something I am missing or is there a known issue with private Github repositories? If I make the repo public then updater finds it and updates perfectly, so the integration is good.

[develar]

#891 (comment)

[develar]

#529 (comment)

[develar]

As your app code is available for everyone, electron updater can use only public resources.

[AlienHoboken]

Is there a reason for that limitation? Why can't electron-updater access private resources with a proper authentication token?

[develar]

Where a proper authentication token can be stored? Or do you want to somehow set it programmatically in setFeedURL?

[AlienHoboken]

The use case is like this:

We have an application which will be distributed on controlled machines, not distributed to the public. Therefore if we create a Github user with read only privileges to our private repository we are fine with storing an authentication token for that user on the machine (in an environment variable, app-update.yaml, wherever) so they can pull releases to update.

Would this be possible with electron-updater? And if so, could you point me in the correct direction?

[develar]

You need to write own provider and use rest api instead of public URL to download files and get latest info. Would you like to help and create PR?

[AlienHoboken]

Yeah if it's doable then I'm fine writing it and submitting a PR. You think the best way to proceed is a new provider? Or should github provider be extended to support private repositories?

[develar]

I prefer new provider because code will be totally rewritten (no common code). But provider name in the conf will be still github, but https://github.com/electron-userland/electron-builder/blob/master/packages/electron-builder-util/src/fs.ts#L166 if token set, PrivateGithubProvider will be created.

[AlienHoboken]

Sounds good, will update with PR

[AlienHoboken]

Submitted PR #1343

[develar]

Please try electron-updater 1.9.0 (thanks to @AlienHoboken)