
Git SyncFlow
CertifiedSync a single flow from Git
Git SyncFlow
Sync a single flow from Git
Imports one flow YAML from a Git branch into a target namespace. Flow namespace is rewritten to targetNamespace. Supports dry-run to validate without saving.
type: io.kestra.plugin.git.SyncFlowExamples
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: company.ops
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
Flow file path
Relative path to the flow YAML inside the repository.
targetNamespace *Requiredstring
Target namespace
Replaces any namespace declared in the flow file.
branch string
mainBranch to clone
Defaults to main.
connectTimeout integerstring
10000HTTP connect timeout (ms)
Default 10000 ms.
dryRun booleanstring
falseDry run only
When true, validates and logs without importing.
gitConfig object
Git configuration overrides
Map of git config keys and values applied after clone, e.g.:
- core.fileMode: false (ignore permission flips)
- core.autocrlf: false (preserve line endings)
noProxy booleanstring
Disable proxy for HTTP
When true, forces direct connections instead of using the JVM proxy settings.
passphrase string
Passphrase for privateKey
password string
Password or personal access token
Supplies HTTP credentials. When a PAT is used, pushes are recorded under that PAT’s user without needing authorName and authorEmail.
**GitHub PAT permissions required: **
- Fine-grained PAT:
Contents: Read(clone/fetch) orContents: Read and Write(push), plusMetadata: Read(mandatory base permission). AddWorkflows: Read and Writewhen pushing.github/workflows/files. - Classic PAT:
reposcope covers all read/write operations; addworkflowwhen pushing workflow files.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
privateKey string
PEM private key
PEM-formatted private key matching a public key registered on the Git server. Generate with ssh-keygen -t ecdsa -b 256 -m PEM.
readTimeout integerstring
60000HTTP read timeout (ms)
Default 60000 ms.
trustedCaPemPath string
Extra trusted CA PEM path
Optional PEM-encoded CA bundle added to the JVM truststore; equivalent to git config http.sslCAInfo <path> for self-signed or internal CAs.
url string
Repository URL
HTTP(S) or SSH URI used for clone and push operations.
username string
Username or organization
Used for HTTP basic authentication and as a fallback commit author.
Outputs
flowId string
The ID of the synced flow
namespace string
The namespace of the synced flow
revision integer
The new revision number of the flow