NPM Update Action

NPM Update

Name

A friendly name for this action (will be displayed in the actions workflow area).

Enabled

Determines if this action will be run within the relevant stage.

Package Directory

The path where the package(s) to be updated are located. Relative paths will be anchored to the workspace folder.

Package Name(s)

Name or names of packages to be updated separated by a space. Leave empty to update all packages.

Use custom registry

Tick to open a new Registry tab to specify a custom NPM registry rather than the default registry of NPM. [---registry=]

Using

The Using drop down is populated with any property collector whose namespace matches the pattern defined by the NPM Update action. The pattern for this action is ^NPM.*

If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "NPM Update".

For more in-depth explanations on property collectors see Property Collectors.

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.

Registry

Registry URL

The full URL end-point of the registry to use. The registry in question will be logged into before the action is run, and then logged out of when the action has completed.

Username

The username of the user with credentials to access the registry entered above. Note that the user should have permission to perform the action in question - whether that be publishing or downloading packages.

Password

The password for the username listed above. Note that some registries allow for either a user password, or feed specific API key to be used when logging into the registry. The password in question will be written to the project specific NPM configuration file and removed after the action has been completed. It is advised to use a user with access limited to the tasks performed by this action.

Email Address

The email address of the user accessing the registry. For publishing, this is the user to whom the published package will be associated with.

Always Authenticate

Indicates that all requests to the given registry should include authorisation information.

Configuration

Configuration File Content

Allows for setting any configuration option for NPM. This is useful for defining registry scopes or any specific system settings that are required for NPM. For information on what options are available and the values that they support please refer to the npmrc help.

The configuration file that is written is project specific and will be saved to the target directory specified in the action. This will override any other options specified in the user, and system NPM configuration files on the agent.

Options

Include development dependencies

Tick to set the --dev argument and cause the devDependencies node in the pacakge.json to be processed when checking which package versions to update.

Save updated version(s) in package

Tick to apply the --save argument which will save the new version as the minimum required dependency in package.json.

Log standard output

If this is ticked, the command line output is written to the build log.

Verbose logging

Tick this to pass the --verbose argument to get more detailed output from the NPM command line. [---verbose]

Timeout (in seconds)

How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).

Treat failure as warning

Tick to continue build on failure marking the action with a warning status.

Ignore warnings

If this is ticked, any warnings logged will not mark the action with a warning status.

Environment

Environment Variables

Multiple environment variables can be defined - one per line. These are set before the command line is run.

Log environment variables

If this is ticked, environment variable values are written to the build log.

Generate system environment variables

Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.

Mask sensitive variable values in system environment variables

This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.

If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.