SyncFlow
Sync a single flow from a Git repository to a Kestra namespace.
Sync a single flow from a Git repository to a Kestra namespace.
Sync a single flow from a Git repository to a Kestra namespace.
type: "io.kestra.plugin.git.SyncFlow"Examples
Sync a single flow from a Git repository to a specific namespace. This can be used to deploy or update individual flows.
id: sync_single_flow_from_git
namespace: system.cicd
tasks:
- id: sync_my_flow
type: io.kestra.plugin.git.SyncFlow
url: https://github.com/my-org/kestra-flows
branch: main
username: my_git_username
password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
targetNamespace: dev.marketing # required
flowPath: "flows/marketing/flow.yml" # required
Properties
flowPath*Requiredstring
The full path to the flow YAML file within the Git repository
targetNamespace*Requiredstring
The target namespace where the flow will be synced
branchstring
mainThe branch to clone from
connectTimeoutintegerstring
10000Connect timeout in milliseconds for HTTP connections.
dryRunbooleanstring
falseIf true, the task will only log the action without actually syncing the flow.
gitConfigobject
Git configuration to apply to the repository
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
noProxybooleanstring
Specify whether to disable proxy.
passphrasestring
The passphrase for the privateKey
passwordstring
The password or Personal Access Token (PAT) – when you authenticate the task with a PAT, any flows or files pushed to Git from Kestra will be pushed from the user associated with that PAT. This way, you don't need to configure the commit author (the authorName and authorEmail properties).
privateKeystring
PEM-format private key content that is paired with a public key registered on Git
To generate an ECDSA PEM format key from OpenSSH, use the following command: ssh-keygen -t ecdsa -b 256 -m PEM. You can then set this property with your private key content and put your public key on Git.
readTimeoutintegerstring
60000Read timeout in milliseconds for HTTP connections.
trustedCaPemPathstring
Optional path to a PEM-encoded CA certificate to trust (in addition to the JVM default truststore)
Equivalent to git config http.sslCAInfo <path>. Use this for self-signed/internal CAs.
urlstring
The URI to clone from
usernamestring
The username or organization
Outputs
flowIdstring
The ID of the synced flow
namespacestring
The namespace of the synced flow
revisioninteger
The new revision number of the flow
