YAML for NPM Publish

View as Markdown

Publish a artifact to an NPM registry.

YAML parameters for NPM Publish

PARAMETERS
npm_registryrequiredstring enum
The NPM registry type to use for publishing.
Allowed enum:
NPM,
GIT_HUB,
OTHER
typerequiredstring

Value: NPM_PUBLISH

actionrequiredstring
Unique identifier for the action within the pipeline.
integrationstring
NPM integration for authentication. It refers to an integration in the workspace by its identifier, not by its display name.
accessstring enum
The access level for the published artifact.
Allowed enum:
RESTRICTED,
PUBLIC
ignore_scriptsboolean
When true, lifecycle scripts will not be executed during publish.
tagstring
The distribution tag to use when publishing the artifact.
source_pathstring
The path to the artifact directory to publish.
registrystring
The URL of the registry to publish to. Required with npm_registry: OTHER.
tokenstring
The authentication token for the registry. Required with npm_registry: OTHER; for NPM and GIT_HUB the token comes from integration.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
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
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.

Last modified on Nov 2, 2026

YAML examples for NPM Publish

Publish artifact to NPM registry

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

Publish to a custom NPM registry with a token

yaml
- action: "Publish to private registry"
  type: "NPM_PUBLISH"
  npm_registry: "OTHER"
  registry: "https://npm.example.com/"
  token: "$NPM_TOKEN"
  source_path: "/buddy/my-artifact"