YAML for NPM Stage

View as Markdown

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

YAML parameters for NPM Stage

PARAMETERS
integrationrequiredstring
NPM integration for authentication. It refers to an integration in the workspace by its identifier, not by its display name.
npm_registryrequiredstring enum
The NPM registry type to use for staging. Only NPM is supported.
Allowed enum:
NPM,
GIT_HUB,
OTHER
typerequiredstring

Value: NPM_STAGE

actionrequiredstring
Unique identifier for the action within the pipeline.
accessstring enum
The access level for the staged artifact.
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. ON_SUCCESS actions run after every successful run, also one ended by an EARLY_EXIT action.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
Names of the variables to loop over (IMAGES, not $IMAGES and not a value). The action runs once for each item of the value, and once for each combination of items when several variables are listed. The variable value is split into items by new lines, or by commas when it has no new lines (a single-line JSON object or key=value pairs stays one item). An item that is a JSON object or key=value pairs also sets one variable per key, named <VARIABLE>_<key>; an item that starts with EXTRACT: sets them as plain <key>.
run_only_on_first_failureboolean
When true, the action runs only on the first failure instead of on each failure. Used only when 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. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.
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.

Constraints: ≤ 10

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.

Outputs for NPM Stage

OUTPUT VARIABLES
BUDDY_ACTION_NPM_STAGE_APPROVE_URL
URL of the npm staged packages page where the published version can be approved.

Example: https://www.npmjs.com/settings/mycompany/staged-packages

Last modified on Nov 19, 2026

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