automatic-updates

automatic-updates

Tools to automatically update nodejs programs installed as modules from npm/github.

npm

Check the version of the installed module and compares with the lastest module in npm to check whether to install new module using npm install -g

Only public npm packages are supported. If you'd like your application to be private, you can consider using github

github

Runs git pull and gets github cli handle the rest.

This allows the program to freely reside in private github repos and still be able to auto-update. This requires an ssh key to be supplied.

For using github, you will create a file in ~/etc/${yourprojectname}/system.yaml with the contents:

sshKey: path to ssh key

Project name is the name in package.json. The active branch is master. So ensure you use that as your default branch instead of main.

usage

const automaticUpdates = require('automatic-updates');
automaticUpdates.on('updated', ()=>{
    process.exit() // what to do restart the service in case of an update
});
automaticUpdates.init()

api

automaticUpdates

Automatic Updates

Kind: global class

• automaticUpdates
  • .interval
  • .source
  • .init(options)
  • .updateFromGithub()
  • .updateFromnpm()
  • .updateModules()

automaticUpdates.interval

Update Interval

Kind: instance property of automaticUpdates

automaticUpdates.source

Source from which to update

Kind: instance property of automaticUpdates

automaticUpdates.init(options)

Initialize automatic updates

Kind: instance method of automaticUpdates

Param	Type	Default	Description
options	object		Options
[options.interval]	number	3600	Interval over which to check for updates.
[options.source]	string	"npm"	The source from which to check for updates.

automaticUpdates.updateFromGithub()

Update using git pull from github repo

Kind: instance method of automaticUpdates

automaticUpdates.updateFromnpm()

update from npm

Kind: instance method of automaticUpdates

automaticUpdates.updateModules()

update node modules for current project

Kind: instance method of automaticUpdates