The NPM Pack action is used to build NPM packages for publishing to a registry.
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.
Target Directory
Where the package will be placed. Relative paths will be anchored to the workspace folder.
Package Location Type
The type of package location. This can be a directory, file, URL or definition which describes the location of the npm package to build.
Package Folder
This input box is displayed if you choose Directory for the Package Location Type. Enter the path to the folder which contains the package.json file describing the package.
Package File
This input box is displayed if you choose File for the Package Location Type. Enter the path to a gzipped tarball containing the NPM package to build.
Package URL
This input box is displayed if you choose Url for the Package Location Type. Enter the Url to a gzipped tarball or Git repository containing the NPM package to build. You can enter a http or https URL or one of the following special URL formats for accessing Git repositories.
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:/]<path>[#<commit-ish>]where protocol is one ofgit,git+ssh,git+http, orgit+https<githubname>/<githubrepo>[#<commit-ish>]orgithub:<githubname>/<githubrepo>[#<commit-ish>]for installing packages from github.com repositoriesgist:[<githubname>/]<gistID>[#<commit-ish>]for installing packages uploaded to gist.github.combitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]for installing packages from bitbucket.org repositoriesgitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]for installing packages from gitlab.com repositories
where <commit-ish> indicates a commit hash, branch or tag name. This defaults to master.
Package Definition
This input box is displayed if you choose Definition for the Package Location Type. Enter the name of a package that is published on the official npm registry. You can also optionally specify the scope, tag or version using the following formats:
[@<scope>/]<name>[@<scope>/]<name>@<tag>[@<scope>/]<name>@<version>[@<scope>/]<name>@<version range>
You can also specify multiple package definitions separated with a space.
Use custom registry
Allows for a custom registry to be defined. If not checked then the default registry of npm is used.
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.
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 written 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.
Log standard output
Tick this to log output from the NPM command line.
Verbose logging
Tick this to pass the --verbose argument to get more detailed output from the NPM command line.
Timeout (in seconds)
The number of seconds to wait for the package to be built. A value of zero will mean the action will wait 24 hours before stopping due to a timeout. Use this option to handle timeouts for external package downloads.