Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitFAQCLIAPI

YAML for NPM Stage

View as Markdown

Stage an artifact in the NPM registry for approval before publishing.

YAML parameters for NPM Stage

PARAMETERS
typerequiredstring

Value: NPM_STAGE

actionrequiredstring
Unique identifier for the action within the pipeline.
integrationstring
NPM integration for authentication.
npm_registrystring enum
The NPM registry type to use for staging. Only NPM is supported.
Allowed enum:
NPM,
GIT_HUB,
OTHER
accessstring enum
The access level for the staged artifact: PUBLIC or RESTRICTED.
Allowed enum:
RESTRICTED,
PUBLIC
ignore_scriptsboolean
When true, lifecycle scripts will not be executed during publish.
tagstring
The distribution tag to use when staging the artifact.
source_pathstring
The path to the artifact directory to stage.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Jul 13, 2026

Previous pageNPM PublishNext pagePing monitoring

YAML examples for NPM Stage

Stage artifact in NPM registry

yaml
  - action: "Stage to NPM"
    type: "NPM_STAGE"
    integration: "npm_integration"
    npm_registry: "NPM"

Stage artifact in NPM registry with all options

yaml
  - action: "Stage to NPM"
    type: "NPM_STAGE"
    integration: "npm_integration"
    npm_registry: "NPM"
    source_path: "/buddy/my-artifact"
    tag: "latest"
    access: "PUBLIC"
    ignore_scripts: true