NPM Run Action

NPM Run

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.

Working Directory

The path where the package is located. Relative paths will be anchored to the workspace folder.

Command

Name of the script command to run. This should match the name defined in the scriptssection of the package.json file.

Command Arguments

Optional list of arguments to pass to the command. [---]

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.

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 npmrchelp.

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.

Settings

Script Shell

The path to the shell to use to run the script command. This defaults to "cmd.exe" if left empty.

Run script only if present

If this is ticked, the action will not fail when the a script command is not defined in the scripts section of the package.json file.

Ignore pre- and post-scripts

If this is ticked, any pre- or post-scripts defined in the scripts section of the package.json file will not be run.

Options

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.