YAML for Git Push

View as Markdown

Push changes to a Git repository with support for tags and signing.

YAML parameters for Git Push

PARAMETERS

targetsrequiredobject[]

The list of target repositories to push to

typerequiredstring

Value: PUSH

actionrequiredstring

Unique identifier for the action within the pipeline.

push_tagsboolean

When true, push tags along with commits.

target_branchstring

Target branch to push to.

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.

commentstring

Commit message for the push.

tagstring

Tag to create and push.

custom_optionsstring

Custom git options to pass.

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

Git Merge Gitcrypt lock

YAML examples for Git Push

Git push with tags

yaml
  - action: "Git Push"
    type: "PUSH"
    push_tags: true
    target_branch: "$BUDDY_RUN_BRANCH"
    comment: "$BUDDY_RUN_ID"
    tag: "example"
    custom_options: "--force"
    deployment_excludes:
      - "example_file_to_ignore"
    targets:
      - "example_git_push_target"
    without_force: false
    use_custom_gitignore: true

Git Push with password authentication target

yaml
  - action: "Git Push"
    type: "PUSH"
    target_branch: "$BUDDY_RUN_BRANCH"
    targets:
      - target: git_password
        type: GIT
        repository: https://github.com/example/my-repository
        name: example_name
        auth:
        username: user
        password: example_password

Git Push with SSH key authentication target

yaml
  - action: "Git Push"
    type: "PUSH"
    target_branch: "$BUDDY_RUN_BRANCH"
    targets:
      - target: git_workspace
        type: GIT
        repository: https://github.com/example/my-repository
        name: GIT WORKSPACE
        auth:
        method: SSH_KEY
        key: example_ssh_key

Git Push with asset key authentication target

yaml
  - action: "Git Push"
    type: "PUSH"
    target_branch: "$BUDDY_RUN_BRANCH"
    targets:
      - target: git_workspace
        type: GIT
        repository: https://github.com/example/my-repository
        name: GIT WORKSPACE
        auth:
        method: ASSETS_KEY
        asset: example_asset_name