Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesTerraformTunnelsYAMLBuddy GitCLIAPIFAQ

YAML for Jira Deployment

View as Markdown

Send deployment information to Jira.

YAML parameters for Jira Deployment

PARAMETERS
integrationrequiredstring
Jira integration for authentication. It refers to an integration in the workspace by its identifier, not by its display name.
typerequiredstring

Value: JIRA_DEPLOYMENT

actionrequiredstring
Unique identifier for the action within the pipeline.
issue_keystring
The Jira issue key to associate with this deployment (e.g., PROJ-123). Auto-extracted from commit message or branch name if not provided.
display_namestring
Display name for the deployment in Jira.
descriptionstring
Description of the deployment.
statestring
The state of the deployment (e.g., successful, failed, in_progress, cancelled, pending, rolled_back, unknown). Auto-extracted from pipeline step status if not provided.
environment_idstring
The unique identifier of the target environment. Auto-resolved from attached Environment if not provided.
environment_namestring
The display name of the target environment. Auto-resolved from attached Environment if not provided.
environment_typestring
The type of environment (e.g., production, staging, testing, development, unmapped). Auto-resolved from attached Environment if not provided.
contentstring
Message content to send. Supports Markdown and Buddy variables.
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

Previous pageJira BuildNext pageJMeter CLI

YAML examples for Jira Deployment

Send deployment info to Jira

yaml
- action: "Send deployment info to Jira"
  type: "JIRA_DEPLOYMENT"
  trigger_time: "ON_EVERY_EXECUTION"
  integration: "jira_integration"
  description: "Deployment of revision $BUDDY_RUN_COMMIT"
  issue_key: "PROJ-123"
  display_name: "Deploy #$BUDDY_RUN_ID to production"
  state: "successful"
  environment_id: "prod-eu"
  environment_name: "Production EU"
  environment_type: "production"