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

A complete example showing how to use `electron-updater`
https://github.com/iffy/electron-updater-example

electron electron-updater macos windows

Last synced: 11 days ago
JSON representation

A complete example showing how to use `electron-updater`

• Host: GitHub
• URL: https://github.com/iffy/electron-updater-example
• Owner: iffy
• License: unlicense
• Created: 2017-02-03T17:17:34.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-15T17:22:12.000Z (about 3 years ago)
• Last Synced: 2024-08-01T02:33:30.862Z (3 months ago)
• Topics: electron, electron-updater, macos, windows
• Language: JavaScript
• Size: 64.5 KB
• Stars: 603
• Watchers: 15
• Forks: 640
• Open Issues: 13
• 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, either fork this repo or [start your own from a template](https://github.com/iffy/electron-updater-example/generate). Then 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 "Developer ID Application" 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://www.electron.build/code-signing).

   

    This example application is set up to perform code-signing and notarization on Mac OS provided that a `Developer ID

    Application` certificate is installed in the default keychain.  The following environment variables are important for the signing process:

    - `CSC_IDENTITY_AUTO_DISCOVERY` - controls whether `electron-builder` tries to sign the application; default is `true`, set to `false` to skip signing

    - `APPLE_ID` - the Apple ID to use for notarization (required for signing).

    - `APPLE_ID_PASSWORD` - the password to use with the specified Apple ID for notarization (required for signing).  Apple recommends setting up an app-specific password to safeguard the Apple ID password (see [Apple Support](https://support.apple.com/en-us/HT204397)) for more information.

    To enable code-signing and notarization:

        export CSC_IDENTITY_AUTO_DISCOVERY="true"

        export APPLE_ID=""

        export APPLE_ID_PASSWORD=""

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 your IDE/Terminal to inherit latest env variable.

5. Publish for your platform with:

        electron-builder -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": "electron-builder --mac --win -p always"

        },

        ...

   NOTE: The Mac OS signing/notarization process must be run on Mac OS.

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.