YAML for Heroku

View as Markdown

Heroku (HEROKU)

YAML parameters for Heroku

PARAMETERS
application_namerequiredstring
The name of the application
integrationrequiredstring
Heroku integration (HEROKU). It refers to an integration in the workspace by its identifier, not by its display name.
typerequiredstring

Value: HEROKU

actionrequiredstring
Unique identifier for the action within the pipeline.
without_forceboolean
When true, do not use --force flag.
isolatedboolean
When true, use isolated git environment.
use_custom_gitignoreboolean
When true, use custom .gitignore file.
deployment_excludesstring[]
Paths to exclude from push.
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.

Last modified on Nov 19, 2026

YAML examples for Heroku

Deploy to Heroku

yaml
- action: "Deploy to buddy-app"
  type: "HEROKU"
  application_name: "buddy-app"
  integration: "my_integration"
  use_custom_gitignore: false
  isolated: true