Skip to content
Simple way to publish releases for electron-simple-updater
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib Remove debug message from clean command Jan 28, 2019
spec Cosmetics Jan 24, 2019
.eslintrc Refactoring: commands; single updates.json publish on several builds Jan 24, 2019
.gitignore Cosmetics Jan 24, 2019
.npmrc Closes #33 folders Nov 10, 2017
.travis.yml More user friendly message for remove and clean commands Jan 24, 2019
LICENSE Initial commit Oct 20, 2016
README.md Add clean command Jan 24, 2019
index.js Refactoring: commands; single updates.json publish on several builds Jan 24, 2019
package.json Remove debug message from clean command Jan 28, 2019

README.md

logo

electron-simple-publisher

Build Status npm version

Description

This module makes easy to publish updates created by electron-builder. Now SSH, github, ftp, Amazon S3 and local release transports are supported. You can enable update feature in your application using electron-simple-updater

Installation

Install with npm:

npm install --save-dev electron-simple-publisher

Usage

  1. For windows build set the target value to squirrel in package.json:
...
"build": {
  ...
  "win": {
    "target": "squirrel"
  }
},
...
  1. Make a distributive package using electron-builder

  2. Set options: You can specify all option through command line arguments, but it's easier to store the config in publisher.js or publisher.json in the project root. Here is an example for publishing through SSH:

{
  "transport": {
    "module": "ssh",
    "host": "example.com",
    "username": "user",
    "password": "user's password",
    "remotePath": "/www/example.com/updates",
    "remoteUrl": "http://example.com/updates",
  },
  "fields": { // Additional fields which will be added to updates.json
    "readme": "The first version"
  },
  // If you've already set package.json:updater.url you can skip this option:
  "updatesJsonUrl": "http://example.com/updates/update.json",
  // Builds contained these substrings will be ignored when run clean command
  "except": [
    "prod-v0.5.0"
  ]
}
  1. Run a publish command:

$ node_modules/.bin/publish - will publish the latest build for the current platform

Command line arguments

Usage: publish [command] [options] [arguments]

Commands (default is publish):
  publish [configFile] [buildId1 Id2 …|all] Publish a new build(s).
  replace [configFile] [buildId]            Replace the current build.
  remove  [configFile] [buildId1 Id2 …]     Remove one or more builds.
  clean   [configFile]                      Remove builds missed in updates.json
    -e or --except NAME1,NAME2              NAME1,NAME2 will be preserved
  list    [configFile]                      Show builds on a hosting.

BuildId has a following format: [platform]-[arch]-[channel]-v[version]
  You can specify only a part of buildId, like linux-x64, defaults:
    platform: process.platform
    arch:     process.arch
    channel:  package.json:updater.channel or prod
    version:  package.json:version

Options:
  configFile          File with json ext, defaults to ./publisher.js
  -t or --transport   Name of node module which implements Transport interface.
  --transport-{name}  Specify the {name} transport option
  -p or --path        Path to distributive files (default dist).
  -d or --debug       Show debug information
  -n or --noprogress  Don't show upload progress
  --field-{name}      Set updates.json:{buildId}.{name} field 
  -h or --help        Show this message

Transports

SSH

Upload releases using SSH protocol. This transport uses ssh2 internally so you can check its documentation for all transport options.

Github

Upload updates to github releases. You can use this transport even if you don't want to share your source code. For this purposes you just need to create a public repository which will store your releases.

FTP

Upload releases using FTP protocol. This transport uses node-ftp internally so you can check its documentation for all transport options.

Amazon S3

Upload releases to S3 storage.

Local

This transport allows to create file structure which can be uploaded to a server manually.

Related

License

Licensed under MIT.

You can’t perform that action at this time.