
Git SyncBlueprints
CertifiedEnterprise EditionSync Custom Blueprints from Git to Kestra
Git SyncBlueprints
Sync Custom Blueprints from Git to Kestra
This task syncs custom blueprints from a given Git branch to Kestra. If the delete property is set to true, any blueprint available in Kestra but not present in the gitDirectory will be deleted, considering Git as a single source of truth. Check the Version Control with Git documentation for more details.
type: io.kestra.plugin.ee.git.SyncBlueprintsExamples
Sync custom blueprints from a Git repository.
id: sync_blueprints_from_git
namespace: company.ops
tasks:
- id: git
type: io.kestra.plugin.ee.git.SyncBlueprints
delete: true
url: https://github.com/kestra-io/blueprints
branch: main
username: git_username
password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
dryRun: true
triggers:
- id: every_full_hour
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 * * * *"
Properties
branch string
mainThe branch from which blueprints will be synced to Kestra
cloneSubmodules booleanstring
Whether to clone submodules
delete booleanstring
falseWhether you want to delete blueprints present in Kestra but not present in Git
It's false by default to avoid destructive behavior. Use this property with caution because when set to true, this task will delete all blueprints that are not present in Git rather than only overwriting the changes.
dryRun booleanstring
falseIf true, the task will only output modifications without performing any modification to Kestra. If false (default), all listed modifications will be applied
failOnMissingDirectory booleanstring
trueIf true (default), the task will fail if the specified directory doesn't exist. If false, missing directories will be skipped
gitConfig object
Git config applied after clone
Map of Git config keys and values, applied after clone
Few examples:
- 'core.fileMode': false -> ignore file permission changes
- 'core.autocrlf': false -> prevent line ending conversion
gitDirectory string
_blueprintsDirectory from which blueprints should be synced
knownHosts string
Known hosts file content used for SSH host key verification
OpenSSH known_hosts-formatted content used to verify the remote server's SSH host key. If not set, the system/user known_hosts file is used.
passphrase string
Passphrase for privateKey
password string
Password or personal access token
When set, pushes use the identity tied to this credential, so authorName and authorEmail become optional.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
privateKey string
SSH private key in PEM format
Use an ECDSA/PEM key whose public part is registered on Git. Example: ssh-keygen -t ecdsa -b 256 -m PEM.
strictHostKeyChecking booleanstring
trueWhether to verify the SSH remote server's host key
When true (default), the host key presented by the Git server is verified against knownHosts (if provided) or the system/user known_hosts file, protecting against man-in-the-middle attacks. Only disable this for trusted networks/testing.
url string
Git repository URL
HTTPS or SSH URL used for clone/fetch/push. Supports templating.
username string
Repository username or organization