Plug-in Documentation

NPM for IBM UrbanCode Build

Overview

Compatibility

This plug-in requires version 6.1.2 or later of IBM UrbanCode Build. This plug-in is supported to run on all operating systems that are supported by the IBM UrbanCode Build agent and NPM.

Installation

No special steps are required for installation.

History

Version 1

Version 1 is the initial, publicly available version of the plugin.

Steps

Process steps in the NPM plug-in

NPM Config

Manage NPM configuration files

Input properties for the NPM Config step
Name Type Description Required
Arguments String Add arguments for the config command. If there are multiple lines of arguments, each
line will result in a separate npm config subcommand argument execution.
No
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No
Sub-command Enumeration:

  • set
  • get
  • list
  • delete
Select a config sub-command Yes

NPM Init

Create a package.json with default values.

Input properties for the NPM Init step
Name Type Description Required
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No

NPM Install

Install a package, and any package that it depends on.

Input properties for the NPM Install step
Name Type Description Required
Arguments String Add arguments for the install command in one or multiple lines. No
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No

NPM Publish

Publish a package.

Input properties for the NPM Publish step
Name Type Description Required
Access Enumeration:

  • public
  • restricted
The package access level after publishing. This is either public or restricted. No
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No
Package String Package location e.g. a folder containing a package.json file or a url or file path
to a gzipped tar archive containing a single folder with a package.json file inside.
NPM will publish . if no package is supplied.
No
Tag String Registers the published package with the given tag. No

NPM Uninstall

Uninstall a package, completely removing everything NPM installed on its behalf.

Input properties for the NPM Uninstall step
Name Type Description Required
Arguments String Add arguments for the uninstall command in one or multiple lines. No
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No

NPM Update

Update a package.

Input properties for the NPM Update step
Name Type Description Required
Arguments String Add arguments for the update command in one or multiple lines. If no package names
are specified, all packages in the specified location (global or local) will be updated.
No
NPM Executable String The location of the NPM executable. If left empty, the NPM executable should be in
the path environment variable.
No