Git Push with YAML
Tip
Learn more about:
Git Push [Password]
YAML parameters for Git Push [Password]
Name | Type | Description |
---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to PUSH . |
push_url Required | String | The url to the repository. |
git_auth_mode Required | String | The authentication mode for GIT. Should be set to HTTP . |
tag | String | The name of the tag to push. |
login | String | The username required to connect to the server. |
password | String | The password required to connect to the server. |
push_tags | Boolean | Defines whether the tags should be pushed to the remote repository or not. |
use_custom_gitignore | Boolean | When set to false the push will ignore paths listed in .gitignore file. |
isolated | Boolean | When set to true , action will push only repository files (without artifacts). |
target_branch | String | Defines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch. |
deployment_excludes | String[] | The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true . |
without_force | Boolean | Defines whether the --force flag should be used when invoking the git push command or not. |
comment | String | Optional custom git commit message. |
custom_options | String | Use custom git push options. |
YAML example for Git Push [Password]
yamlactions: - action: "Push to https://app.buddy.works/buddy/repo" type: "PUSH" login: "api_tests_user" password: "api_tests_password" push_tags: false git_auth_mode: "HTTP" target_branch: "$BUDDY_EXECUTION_BRANCH" push_url: "https://app.buddy.works/buddy/repo" comment: "$BUDDY_EXECUTION_ID" tag: "tagName" deployment_excludes: - "/tmp/" use_custom_gitignore: true custom_options: "--no-verify" without_force: false
Git Push [Private key]
YAML parameters for Git Push [Private key]
Name | Type | Description |
---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to PUSH . |
git_auth_mode Required | String | The authentication mode for SSH. Should be set to PRIVATE_KEY . |
push_url Required | String | The url to the repository. |
server_key Required | String | The private SSH key. |
tag | String | The name of the tag to push. |
push_tags | Boolean | Defines whether the tags should be pushed to the remote repository or not. |
use_custom_gitignore | Boolean | When set to false the push will ignore paths listed in .gitignore file. |
isolated | Boolean | When set to true , action will push only repository files (without artifacts). |
target_branch | String | Defines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch. |
deployment_excludes | String[] | The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true . |
without_force | Boolean | Defines whether the --force flag should be used when invoking the git push command or not. |
comment | String | Optional custom git commit message. |
custom_options | String | Use custom git push options. |
YAML example for Git Push [Private key]
yamlactions: - action: "Push to https://app.buddy.works/buddy/repo" type: "PUSH" git_auth_mode: "PRIVATE_KEY" server_key: ""-----BEGIN RSA PRIVATE KEY-----\r\nProc-Type: 4,ENCRYPTED\r\nDEK-Info: DES-EDE3-CBC,688DBB59CFC83D58\r\n\r\n1m3qZGEqXEfLPIm9KZacr17/iMVOIJcvSLoMJueM8+QbcK4JStzbre2AN99TkCN/\r\nr1V12deiq/lJUPX07K30tnsTS+7z4Pq/D2WhirD+WQcREgdQU1A8dlx2NMRDi7d0\r\n32w8ZPlciz3bc5rpF0vy5Ll2q9TWye4fpgQwPUnEkam0SaRRwAMpnT/46/AeWgmn\r\n9nu8CNZp7QcOIR2WH6RNRhQTOD/hC+kVCxbEQUL5MOHV7iZX6BeUwd8bBNmci+o0\r\nz/I7ZLQo596Ih+0KPgA+vwS9c4c1TrUYhupU7tyIL6PwpAzhlq/UwxeE032AypiI\r\nkpm7z8I7MBYZs0bsS5UOa3FdHF8p38KrxozwQfsOmBxEHpAWM3slvqJpauuJLlyx\r\ncFfzgOTFSsLJ5J59ZdVRpeFr/W5+/9wpc+AJUP80i4pMEWsnamwdK9rU6QwpFiPf\r\nARzk6VdIiDlZRWeyoYcEfOGEJt+J0aSlXkt6BHgvkmDGq0YA9CNqb6GdB9t073yX\r\nCAqsQ/XEvDuZw14KHxErr5aL6uuZiioDhUmoGz9S3HstFR4T0nRmfCSrLyxTFQf1\r\nF0Sn9Dv4LrSGrzM/0svdlqUc5TDxPBVoW2Q56dNkAQwJg0k25x5YLdTUcd4GjbJW\r\n0qLJaO+bxfTDk5rCMHflYNCW18fEdeEvpBwL0ey93+Qya4xqjTOy2fgoz9U0QLUD\r\nfbgWSiFWnurC8I/SYcQUAEOKiYCDRzud92WzyjwRr2yPlcqf/Qi8+VNDyvoGYZgi\r\nD3vgqA9KPKnYkODYKIFTMW0bbRkgnLOsc1v5mkPTerUpeOGWPysOu3WV9if9e2lG\r\npG1gVfRJQei0k5Mex6CCV0gSQbf2MjswiyDvrPQ1yhpCsFeDAGKcLx+GU1/AhLRP\r\np32mqF5XJrMSTvifCGNOHkBMVUXmTjF7KCYZvcsERi1i2xNcwtcsLRm+QJKQsYQf\r\nhJ17/lOOcC8cqVLGmik3adOcOMCWq2b+NjgoJT55Hc0N07ikuQqazhFpZKkMFZEr\r\nFqbDZ2zGMwODjcDancXaghSS7ciIEdoAPGor1rftJ+l2oQVzBPk4pNfBKHJC7UmS\r\nUOGW3rGLSlRQcVEBFHbrsGP/JKXd06Cbrc3kDrdXbO430qRZh9LQQKbjvxHonU8Z\r\nXFeRpwG32YLSCSQunJtoEWQRJpVefc7rEmBAdLfNyA7xyqH2JLtlflaH9QApl7vE\r\nGNJJ5iuHCHPJwfhlaSMBF/Cb9Ofp4BM5fnNKrwaI9twv//U6XhVfYRcaKhCFEoMb\r\nYo4k7cKTQzL95xT1aYnwqSqtaDfoXASoA9j/mD0aMU+9zQEa0tVbJ/6Zjn3vMSTx\r\npvCYkXy9kZzEJZ2r7BiaQX0HX5Ki/Opt4eTWL5NbokDsE1bQu+D2BskJz30pRRRK\r\nvRargCRNl26158HNRLPkbo/gkwfJbfIBFgJ8YEQkcNap110oEaW6l3lnktZ0Ct3P\r\nEjkrppoV6UU1HCVmcoljOldTXQZuKmpz7aIuSwmUqoU4vWNvYteIZ3BhaVwCu/p8\r\nVaFL8Sapda0WYXPWXHuV+Dj295bedJxeqraWrQB87vKP4NVyzWv1WA==\r\n-----END RSA PRIVATE KEY-----\r\n" push_url: "https://app.buddy.works/buddy/repo" comment: "$BUDDY_EXECUTION_ID" tag: "tagName" deployment_excludes: - "/tmp/" use_custom_gitignore: true custom_options: "--no-verify" without_force: false
Git Push [Private key from environment variables]
YAML parameters for Git Push [Private key from environment variables]
Name | Type | Description |
---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to PUSH . |
git_auth_mode Required | String | The authentication mode for SSH. Should be set to ENV_KEY . |
push_url Required | String | The url to the repository. |
env_key Required | String | The private SSH key name defined in environment variables. |
tag | String | The name of the tag to push. |
push_tags | Boolean | Defines whether the tags should be pushed to the remote repository or not. |
use_custom_gitignore | Boolean | When set to false the push will ignore paths listed in .gitignore file. |
isolated | Boolean | When set to true , action will push only repository files (without artifacts). |
target_branch | String | Defines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch. |
deployment_excludes | String[] | The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true . |
without_force | Boolean | Defines whether the --force flag should be used when invoking the git push command or not. |
comment | String | Optional custom git commit message. |
custom_options | String | Use custom git push options. |
YAML example for Git Push [Private key from environment variables]
yamlactions: - action: "Push to https://app.buddy.works/buddy/repo" type: "PUSH" git_auth_mode: "ENV_KEY" env_key: "my_key" push_url: "https://app.buddy.works/buddy/repo" comment: "$BUDDY_EXECUTION_ID" tag: "tagName" deployment_excludes: - "/tmp/" use_custom_gitignore: true custom_options: "--no-verify" without_force: false
Git Push [Public Buddy key]
YAML parameters for Git Push [Public Buddy key]
Name | Type | Description |
---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to PUSH . |
push_url Required | String | The url to the repository. |
git_auth_mode Required | String | The authentication mode for SSH. Should be set to PUBLIC_BUDDY_KEY . |
tag | String | The name of the tag to push. |
push_tags | Boolean | Defines whether the tags should be pushed to the remote repository or not. |
use_custom_gitignore | Boolean | When set to false the push will ignore paths listed in .gitignore file. |
isolated | Boolean | When set to true , action will push only repository files (without artifacts). |
target_branch | String | Defines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch. |
deployment_excludes | String[] | The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true . |
without_force | Boolean | Defines whether the --force flag should be used when invoking the git push command or not. |
comment | String | Optional custom git commit message. |
custom_options | String | Use custom git push options. |
YAML example for Git Push [Public Buddy key]
yamlactions: - action: "Push to https://app.buddy.works/buddy/repo" type: "PUSH" git_auth_mode: "PUBLIC_BUDDY_KEY" push_url: "buddy@app.buddy.works:buddy/repo" comment: "$BUDDY_EXECUTION_ID" tag: "tagName" deployment_excludes: - "/tmp/" use_custom_gitignore: true custom_options: "--no-verify" without_force: false
Last modified on Sep 23, 2024