Info |
---|
The NPM actions in Continua are a wrapper around the NPM the npm command line. If you're having trouble using any of the NPM actions, please refer to the NPM Command Line Reference. |
The NPM Pack action is used to build NPM packages for publishing to a registry.
NPM Pack
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 is to will be built fromplaced. Relative paths will be anchored to the workspace folder.
Package Location Type
...
Directory
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 packageinstallation.
File
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 buildinstall.
URL
Package URL
This input box is displayed if you choose Url for the Package Location Type. Enter the Url URL to a gzipped tarball or Git repository containing the NPM package to buildinstall. You can enter a http HTTP or https HTTPS URL or one of the following special URL formats for accessing Git repositories.
...
where <commit-ish>
indicates a commit hash, branch or tag name. This defaults to master.
Definition
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 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
Tick to open a new Registry tab to specify Allows for a custom registry to be defined. If not checked then NPM registry rather than the default registry of npm is usedNPM.
Use Custom Registry
Allows for a custom registry to be defined. If not checked then the default registry of npm is used.
Registry Url
[--registry=]
Using
The Using drop down is populated with any property collector whose namespace matches the pattern defined by the NPM Pack 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 Pack".
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 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 - 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 API key to be used when logging into the registry. The password in question will be written to the project specific npm NPM configuration file and removed after the action has been completed. It is advised to use a user with acccess access limited to the actions tasks performed by the 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 of any configuration option for npmNPM. This is useful for defining registry scopes or any specific system settings that are required for npm installationsNPM. 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 saved to the target directory specified in the action. This will override any other options specified in the user, and system npm NPM configuration files on the agent.
Options
Log standard output
Tick this to log output from the NPM command lineIf 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)
The number of seconds How long 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. 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.