github.md

Github transport

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.

You only need to create a Github API token to use this transport

Configuration example:

package.json

{
  ...
  "updater": {
    "url": "https://raw.githubusercontent.com/user/example/master/updates.json"
  },
  ...
}

publisher.json

{
  "transport": {
    "module": "github",
    "token": "1111111111111111111111111111111111111111"
  }
}

Options

Name	Default	Description
token*		Github API token,
repository	package.json:repository.url	{username}/{reponame}
updatesJsonPath	'updates.json'	Path to updates.json from the repository root

Other SSH options you can find in ssh2 docs