YAML for Storybook
Build Storybook for UI component documentation. docker_image_name and docker_image_tag are required unless the image comes from another action (use_image_from_action: true or image_location: ACTION) or from the artifact registry (image_location: ARTIFACT_REGISTRY).
YAML parameters for Storybook
PARAMETERS
commandsrequiredstring
The commands that will be executed. Several commands go in one multi-line string (a | block), one per line - not a YAML list.typerequiredstring
Value: STORYBOOK
actionrequiredstring
Unique identifier for the action within the pipeline.working_directorystring
The directory in which the pipeline filesystem will be mounted.setup_commandsstring
The command that will be executed only on the first run. Several commands go in one multi-line string (a | block), one per line - not a YAML list.cached_dirsstring[]
The dependencies and directories to be cached and available to every execution in this pipeline.shellstring enum
The name of the shell that will be used to execute commands.Allowed enum:
SH,BASH,POWERSHELLexecute_every_commandboolean
If set to true all commands will be executed regardless of the result of the previous command.mount_filesystem_disableboolean
If set to true, the filesystem will not be mounted in the container.volume_mappingsstring[]
The path preceding the colon is the filesystem path (the folder from the filesystem to be mounted in the container). The path after the colon is the container path (the path in the container, where this filesystem will be located).main_service_namestring
The hostname of the container in which the action is run. The container will be available under this name in the docker network for services.run_as_userstring
All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image).entrypointstring
The entrypoint to use for the Docker container.reset_entrypointboolean
If set to true, resets the default entrypoint set by the image.cache_base_imageboolean
If set to true, the cached version of the image is used, instead of being pulled each time.ignore_image_pull_failuresboolean
If set to true, use cached image on timeouts (only for official images).export_container_pathstring
The path in the container to export.docker_image_namestring
The name of the Docker image.docker_image_tagstring
The tag of the Docker image.image_locationstring enum
The location of the image used by the action.Allowed enum:
PUBLIC_REGISTRY,PRIVATE_REGISTRY,ACTION,ARTIFACT_REGISTRYdocker_registrystring enum
The type of registry from which the image is retrieved.Allowed enum:
NONE,DOCKER_HUB,AMAZON_ECR,GOOGLE_GCR,GOOGLE_ARTIFACT_REGISTRY,OTHER,GIT_HUB_CONTAINER_REGISTRY,ARTIFACT_REGISTRY,DIGITAL_OCEAN_CONTAINER_REGISTRYversionstring
The version of the artifact from artifact registry.use_image_from_actionboolean
If set to true, the image from another action will be used.docker_build_action_namestring
The name of an action in the same pipeline whose Docker image is used. Set it with image_location: ACTION.registrystring
The URL of the Docker registry.insecure_registryboolean
If set to true, the registry will be accessed over HTTP instead of HTTPS.target_stagestring
The target stage of the Dockerfile.do_not_prune_imagesboolean
If set to true, images will not be pruned after the build.loginstring
Username for a registry reached without an integration. A push (repository set) needs an integration or login and password, except for the artifact registry.passwordstring
Password for login, for a registry reached without an integration.servicesServiceYaml[]
The list of services attached to the build environment.targets(string | TargetYaml)[]
The list of target servers or clusters. Each item is a target definition or a filter matching existing targets by identifier: a plain string such as sd* (* as a wildcard) or an object with type: MATCH.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_TERMINATEloopstring[]
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_PARALLELtrigger_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 Storybook
Build Storybook
yaml
- action: "Build Storybook"
type: "STORYBOOK"
trigger_time: "ON_EVERY_EXECUTION"
docker_image_name: "library/node"
docker_image_tag: "18"
commands: |-
npm install
npm run build-storybook