YAML parameters

Name	Type	Description
name `Required`	String	The ID of the action in the YAML definition. 40 chars max (a-zA-Z0-9_)
docker_image_name `Required`	String	The Docker image from which the container is launched.
docker_image_tag `Required`	String	The tag of the Docker image from which the container is launched.
reset_entrypoint	Boolean	If set to `True`, unsets the default entrypoint set by the image.
execute_commands	String[]	The list of commands run in the container.
shell	String	The type of the command shell. Default: bash
title	String	The title of the action displayed on the action tile and the action adding screen. 40 chars max.
category	String	The category of the action. 100 chars max.
inputs	String	The list of inputs displayed on the action view.
tabs	String	The list of tabs displayed on the action view.
output	String []	Defines the tables of environment variables generated by the action for the duration of the pipeline run.
volume_mappings	String	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).
cached_dirs	String []	The additional container’s directories that will be cached between executions.

Name	Type	Description
id `Required`	String	The ID of the input. Used to create the environment variable in the container. 40 chars max (a-zA-Z0-9_). Must be unique. Must not start with buddy. Case sensitive, i.e. `user` and `User` act as two separate inputs.
name	String	The name displayed on the label of the input. 100 chars max. If not provided, fetches the value from the ID and replaces underscores `_` with spacebars.
type	String	The type of the input. Default: `TEXT`
info	String	Adds a description with additional information below the input. 200 chars max.
options	String []	The options of the input. Required by `AUTOSUGGEST` and `SELECT` types.
required	Boolean	Default: `false`.
masked	Boolean	Default: `false`.
default	String	The optional default value injected to the input.

Name	Description
TEXT	A one-line text input. Supports masking.
TEXTAREA	A multi-line text input. Supports masking.
PASSWORD	Used to enter password credentials. Always masked.
SELECT	A selector list. Requires `Options`.
AUTOCOMPLETE	Supports autocompletion. Requires `Options`.
CHECKBOX	A box that can be ticked on and off.
COMMAND	A multi-line text area styled after build actions. Supports masking.
FILESYSTEM_PATH	Used to select paths in the pipeline filesystem. Supports masking.
GITHUB_INTEGRATION	Enables selecting the GitHub integration in the project. Uses the integration ID as the input variable. Generates `GITHUB_TOKEN`.
AWS_INTEGRATION	Enables selecting the AWS integration in the project. Uses the integration ID as the input variable. Generates `AWS_ACCESS KEY` and `AWS_SECRET_KEY`.

Last update:
Sep 13, 2024