Electron Updater App

Windows and Unix minimal Electron applications with auto updates implemented
(based on the electron-quick-start).

Linux	Windows

Try it

The latest version of this example is 1.0.2. So, you can download the 1.0.1 one and see how the app finds the new version and downloads it.

To begin

$ git clone https://github.com/natancabral/electron-updater-app.git
$ cd electron-updater-app
$ npm install
$ npm run start
$ npm run build

Configure

• Token
  • Get your token here or read this
• File YML
  • electron-builder.yml
• Configure package.json
  • build > publish
• Release:
  • Create a realease
  • Title: 1.0.x and Tag: v1.0.x (letter v... on tag)

Token

• You need a token
• https://github.com/settings/tokens/new
• More information

File YML

• Rename fake_electron-builder.yml file to electron-builder.yml and change data

appId: com.natancabral.electron-updater-app
publish:
  provider: github
  owner: natancabral
  repo: electron-updater-app
  token: [YOUR GITHUB ACCESS TOKEN]
  vPrefixedTagName: true

• Sample:

appId: com.[yourusername].[repo]
publish:
  provider: github
  owner: [yourusername]
  repo: [repo]
  token: [token]
  vPrefixedTagName: true

Configure package.json

• Change appId

"appId": "com.[yourusername].[repo]",

• Change publish

"build": {
  "publish": [{
    "provider": "github",
    "owner": "[yourusername]",
    "repo": "[repo]"
  }],
},

• Release to alternative download

"release": {
  "provider": "github",
  "owner": "[yourusername]",
  "repo": "[repo]",
  "releases": "https://github.com/[yourusername]/[repo]/releases/",
  "template": **NO_CHANGE_THIS**
},

Release

• On terminal: npm run build:win:publish or to not publishnpm run build:win
• Upload all file (./dist)
• https://github.com/[yourusername]/[repo]/releases
• Remenber: title: 1.0.x and tag: v1.0.x (letter v... on tag)
• Semantic Versioning: https://semver.org/

Notes

• Documentation here
• afterPackRenameFiles.js to rename package files.
• DEV mode not work, only after npm run build.
• Mac sample 1: article Mac sample 2: article

License

The MIT License.

Author

Natan Cabral natancabral@hotmail.com https://github.com/natancabral/