YAML for GitLab CLI

View as Markdown

Execute GitLab CLI commands with integration-based authentication.

YAML parameters for GitLab CLI

PARAMETERS

integrationrequiredstring

GitLab integration identifier for authentication.

execute_commandsrequiredstring[]

List of shell commands to execute.

typerequiredstring

Value: GIT_LAB_CLI

actionrequiredstring

Unique identifier for the action within the pipeline.

shellstring enum

Shell to use for executing commands: BASH (default), SH, or ZSH.

Allowed enum:

SH,

BASH,

POWERSHELL

setup_commandsstring[]

Commands to run before the main commands (e.g., for installing dependencies).

execute_every_commandboolean

When true, execute all commands even if earlier ones fail.

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

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

Defines whether the action should be executed on each failure. Restricted to and required if the 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.

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.

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 Jul 31, 2025

GitHub Release Google App Engine

YAML examples for GitLab CLI

Run GitLab CLI commands

yaml
  - action: "GitLab CLI"
    type: "GIT_LAB_CLI"
    shell: "SH"
    integration: "my_gitlab_integration"
    execute_commands:
      - "glab repo list"
      - "glab mr list --state opened"
    setup_commands:
      - "glab config set git_protocol https"
    execute_every_command: true

Simple GitLab CLI command

yaml
  - action: "List MRs"
    type: "GIT_LAB_CLI"
    integration: "gitlab_integration"
    execute_commands:
      - "glab mr list"