Metadata Editor installer includes an automaic updater that can check for, download and install updates. Metadata Editor is packaged with electron builder and used electron-updater module which allows update from GitHub or any other static file host.

For Metadata Editor, we used GitHub as a host. Electron builder needs a GitHub access token to publish the application. Reference link to create the access token https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/.

"repository": "https://github.com/UserName/RepoName" .

appId: metadataeditor
publish:
    provider: github    
    token: <access-tocken>    
win:
    target: nsis-web    
nsisWeb:
    differentialPackage: true

target can be either nsis(installer) or nsis-web(web installer). web installer is a small setup which downloads the remaining components after it is run. Please see the link https://www.itechtics.com/offlinestandalone-installer-vs-webonline-installer-advantages-disadvantages/ for detailed explanation.

Electron builder will package and publish the application. Add the script ship": "build --win -p always" to build and publish the application

Go to the GitHub page and click releases.

• Draft a new release – Set the “Tag version” to the application version and prefixed it with “v”. eg: v1.0.0

• Once the application is ready to publish, edit the version field in the package.json and run the following command. npm run ship

• Go to the GitHub page and select the draft release and click ‘edit’ and then ‘publish release’

Auto updater CheckforUpdate() method is being called in the application start to check whether there is an update. Once the updates are deployed in GitHub, user will get notified when open the application. This is achieved using autoUpdater API events.

The autoUpdater object emits the following events:

Event: 'error' Returns: error Error Emitted when there is an error while updating.

Event: 'checking-for-update' Emitted when checking if an update has started.

Event: 'update-available' Emitted when there is an available update. The update is downloaded automatically.

Event: 'update-not-available' Emitted when there is no available update.

Event: 'update-downloaded' Returns: event Event releaseNotes String releaseName String releaseDate Date updateURL String Emitted when an update has been downloaded.

On Windows only releaseName is available.

Event: 'before-quit-for-update' This event is emitted after a user calls quitAndInstall().

Differential Update -