NpmBuild - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with NpmBuild Pipeline steps. For more information about NpmBuild Pipeline steps, see NpmBuild.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be NpmBuild for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`integrations`	Specifies an Artifactory Integration or JFrog Platform Access Token Integration where modules will be published. If a FileSpec resource is specified in `inputResources` then this is optional. Otherwise, it is required.	May be required
`inputResources`	Must specify a GitReporesource. The `npm-install` runs on the Git repository at `sourceLocation`. May also optionally specify a FileSpec resource that specifies what files to copy to `sourceLocation` prior to running `npm-install`.	Required Optional

Tag

Description of usage

Required/Optional

integrations

Specifies an Artifactory Integration or JFrog Platform Access Token Integration where modules will be published. If a FileSpec resource is specified in inputResources then this is optional. Otherwise, it is required.

May be required

inputResources

Must specify a GitReporesource. The npm-install runs on the Git repository at sourceLocation.

May also optionally specify a FileSpec resource that specifies what files to copy to sourceLocation prior to running npm-install.

Required

Optional

In addition, these tags can be defined to support the step's native operation:

Note

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag	Description of usage	Required/Optional
`npmArgs`	Specifies a command line string of arguments to use with npm-install.	Optional
`resolverRepo`	The name of the npm repository in Artifactory.	Optional
`repositoryName`	Alternative to `resolverRepo`. Do not set both tags.	Optional
`sourceLocation`	The directory containing the `package.json` file, relative to the GitRepo `path`.	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.