NpmPublish - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be NpmPublish 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`	Must specify an Artifactory Integration or JFrog Platform Access Token Integration .	Required
`inputSteps`	Must specify a named NpmBuild or Bash step.	Required
`outputResources`	Must specify a BuildInfo resource if `autoPublishBuildInfo` is set to `true`. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` is set as an environment variable for the pipeline or the input NpmBuild step, that name and/or number will be used for the output BuildInfo. Otherwise, the default `buildName` and `buildNumber` are `$pipeline_name` and `$run_number.`	May be required

Tag

Description of usage

Required/Optional

integrations

Must specify an Artifactory Integration or JFrog Platform Access Token Integration .

Required

inputSteps

Must specify a named NpmBuild or Bash step.

Required

outputResources

Must specify a BuildInfo resource if autoPublishBuildInfo is set to true.

If JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER is set as an environment variable for the pipeline or the input NpmBuild step, that name and/or number will be used for the output BuildInfo. Otherwise, the default buildName and buildNumber are $pipeline_name and $run_number.

May be required

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
`deployerRepo`	The name of the npm repository to publish in Artifactory.	Optional
`repositoryName`	Alternative to `deployerRepo`. Do not set both tags.	Optional
`forceXrayScan`	When set to `true`, forces an Xray scan after publishing to Artifactory. Default is `false`.	Optional
`failOnScan`	When set to `true`, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step.Configure a Security Rule Default is `true`.	Optional
`autoPublishBuildInfo`	When set to `true`, publishes build info to Artifactory. Default is `false`.	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.