Neutral, Plus or Minus

    electron-simple-publisher

    2.0.1 • Public • Published

    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:
      "metaFileUrl": "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, --except NAME1,NAME2                NAME1,NAME2 will be preserved
      list    [configFile]                      Show builds on a hosting.
    
    BuildId has a following format: [platform]-[arch]-[channel]-[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, --transport        Selected transport
          --transport.{name} Specify a transport option
      -p, --path             Path to distributive files (default dist).
      -d, --debug            Show debug information
      -n, --noprogress       Don't show upload progress
          --fields.{name}    Specify a field in the target updates.json file 
          --help             Show this message
          --version          Show publisher version

    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.

    Azure Blob storage

    Local

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

    Related

    License

    Licensed under MIT.

    Install

    npm i electron-simple-publisher

    DownloadsWeekly Downloads

    110

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    84.8 kB

    Total Files

    42

    Last publish

    Collaborators

    • megahertz