https://github.com/eveningkid/electron-updater-example

Test for electron-updater
https://github.com/eveningkid/electron-updater-example

Last synced: 7 months ago
JSON representation

Test for electron-updater

• Host: GitHub
• URL: https://github.com/eveningkid/electron-updater-example
• Owner: eveningkid
• License: unlicense
• Created: 2018-05-30T07:40:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-30T08:01:50.000Z (over 7 years ago)
• Last Synced: 2025-02-03T23:34:07.711Z (9 months ago)
• Language: JavaScript
• Size: 51.8 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
This repo contains the **bare minimum code** to have an auto-updating Electron app using [`electron-updater`](https://github.com/electron-userland/electron-builder/tree/master/packages/electron-updater) with releases stored on GitHub.

If you can't use GitHub, you can use other providers:

- [Complete electron-updater HTTP example](https://gist.github.com/iffy/0ff845e8e3f59dbe7eaf2bf24443f104)

- [Complete electron-updater from gitlab.com private repo example](https://gist.github.com/Slauta/5b2bcf9fa1f6f6a9443aa6b447bcae05)

**NOTE:** If you want to run through this whole process, you will need to fork this repo on GitHub and replace all instances of `iffy` with your GitHub username before doing the following steps.

1. For macOS, you will need a code-signing certificate.

    

    Install Xcode (from the App Store), then follow [these instructions](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW6) to make sure you have a "Mac Developer" certificate.  If you'd like to export the certificate (for automated building, for instance) [you can](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW7).  You would then follow [these instructions](https://github.com/electron-userland/electron-builder/wiki/Code-Signing).

2. Adjust `package.json` if needed.

    By default, `electron-updater` will try to detect the GitHub settings (such as the repo name and owner) from reading the `.git/config` or from reading other attributes within `package.json`.  If the auto-detected settings are not what you want, configure the [`publish`](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration) property as follows:

        {

            ...

            "build": {

                "publish": [{

                    "provider": "github",

                    "owner": "iffy",

                    "repo": "electron-updater-example"

                }],

                ...

            }

        }

3. Install necessary dependencies with:

        yarn

   

   or

   

        npm install

4. Generate a GitHub access token by going to .  The access token should have the `repo` scope/permission.  Once you have the token, assign it to an environment variable 

    On macOS/linux:

        export GH_TOKEN=""

    On Windows, run in powershell:

        [Environment]::SetEnvironmentVariable("GH_TOKEN","","User")

    Make sure to restart IDE/Terminal to inherit latest env variable.

5. Publish for your platform with:

        build -p always

   or

        npm run publish

   If you want to publish for more platforms, edit the `publish` script in `package.json`.  For instance, to build for Windows and macOS:

        ...

        "scripts": {

            "publish": "build --mac --win -p always"

        },

        ...

    

6. Release the release on GitHub by going to , editing the release and clicking "Publish release."

7. Download and install the app from .

8. Update the version in `package.json`, commit and push to GitHub.

9. Do steps 5 and 6 again.

10. Open the installed version of the app and see that it updates itself.