durable-update v0.0.6

durable-update

Node.js module that allows for easy dependency management

Usage

Install durable-update with npm

npm install --save-dev durable-update

Run durable-update.js

./node_modules/durable-update/bin/durable-update.js

Configuration

Update your package.json file to add a durable-update attribute with configuration to customize the update process on your project to your needs.

Below is the default configuration:

{
//  ...
  "durable-update" : {
      order         : [ 'standard', 'dev', 'optional' ],
      targetVersion : {
        standard : {
          tag : 'stable',
          semver : 'minimum',
        },
        dev : {
          tag : 'stable',
          semver : 'minimum',
        },
        optional : {
          tag : 'stable',
          semver : 'minimum',
        },
      },
      upgradeType   : 'single',
      // upgradeType   : 'all',
      // onFailure     : 'abort',
      onFailure     : 'skip',
      testCommands  : [ 'npm test' ],
      scmCommands    : [ 'git commit -F %file %manifest' ]
    },
//  ...
}

order

An array of enumerated strings representing each type of dependency found in the package manifest.

targetVersion

For each dependency type denoted by the order enumeration, one can specify the target version to which to update a given dependency of that type.

{
  tag : ...,
  semver : ...,
}

tag

semver

upgradeType

How many dependencies to update in a single run

onFailure

What action to take on a failed dependency update

testCommands

An Array of commands that need to be run in order to thoroughly test the package. The failure (non-zero return code) of any of these commands will be treated as a failure to successfully update.

scmCommands

An Array of commands that need to commit changes to source control management. The failure (non-zero return code) of any of these commands will be treated as a failure to successfully commit changes. Certain substitutions are supported.

Substitutions