Git Push with YAML

YAML parameters for Git Push

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to PUSH.
push_url
Required
StringThe url to the repository.
git_auth_mode
Required
StringThe authentication mode for Git Push. Can be one of HTTP, PRIVATE_KEY or PUBLIC_BUDDY_KEY.
server_key
Required
StringThe private SSH key. Required if authentication_mode is set to PRIVATE_KEY.
loginStringThe username required to connect to the server.
passwordStringThe password required to connect to the server.
use_custom_gitignoreBooleanWhen set to false the push will ignore paths listed in .gitignore file.
isolatedBooleanWhen set to true, action will push only repository files (without artifacts).
target_branchStringDefines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch.
deployment_excludesString[]The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
push_tagsBooleanDefines whether the tags should be pushed to the remote repository or not.
without_forceBooleanDefines whether the --force flag should be used when invoking the git push command or not.
commentStringOptional custom git commit message.

YAML example for Git Push

actions:
- action: "Push to https://app.buddy.works/buddy/repo"
type: "PUSH"
login: "api_tests_user"
password: "api_tests_password"
push_tags: true
push_url: "https://app.buddy.works/buddy/repo"
target_branch: "stage"
git_auth_mode: HTTP
server_key: "secure!dN5hXm/7MS9f0ISkfo0agjjxxAMI9wqBkyvtkn6lK6218sFU8owuwTjQHFGEMa01"
use_custom_gitignore: false
isolated: true
without_force: false
comment: "Push from Buddy"