SyncFlows

type: "io.kestra.plugin.git.SyncFlows"

Sync flows from Git to Kestra.

This task syncs flows from a given Git branch to a Kestra namespace. If the delete property is set to true, any flow available in kestra but not present in the gitDirectory will be deleted, considering Git as a single source of truth for your flows. Check the Version Control with Git documentation for more details.

Examples

Sync flows from a Git repository. This flow can run either on a schedule (using the Schedule trigger) or anytime you push a change to a given Git branch (using the Webhook trigger).

id: sync_flows_from_git
namespace: system

tasks:
  - id: git
    type: io.kestra.plugin.git.SyncFlows
    gitDirectory: flows # optional; set to _flows by default
    targetNamespace: git # required
    includeChildNamespaces: true # optional; by default, it's set to false to allow explicit definition
    delete: true # optional; by default, it's set to false to avoid destructive behavior
    url: https://github.com/kestra-io/flows # required
    branch: main
    username: git_username
    password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    dryRun: true  # if true, the task will only log which flows from Git will be added/modified or deleted in kestra without making any changes in kestra backend yet

triggers:
  - id: every_full_hour
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "0 * * * *"

Properties

targetNamespace

• Type: string
• Dynamic: ✔️
• Required: ✔️

The target namespace to which flows from the gitDirectory should be synced.

If the top-level namespace specified in the flow source code is different than the targetNamespace, it will be overwritten by this target namespace. This facilitates moving between environments and projects. If includeChildNamespaces property is set to true, the top-level namespace in the source code will also be overwritten by the targetNamespace in children namespaces.

For example, if the targetNamespace is set to prod and includeChildNamespaces property is set to true, then:

• namespace: dev in flow source code will be overwritten by namespace: prod,
• namespace: dev.marketing.crm will be overwritten by namespace: prod.marketing.crm.

See the table below for a practical explanation:

branch

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: main

The branch from which flows will be synced to Kestra.

cloneSubmodules

• Type: boolean
• Dynamic: ❌
• Required: ❌

Whether to clone submodules.

delete

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: false

Whether you want to delete flows 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 and includeChildNamespaces is also set to true, this task will delete all flows from the targetNamespace and all its child namespaces that are not present in Git rather than only overwriting the changes.

dryRun

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: false

If true, the task will only output modifications without performing any modification to Kestra. If false (default), all listed modifications will be applied.

flowService

• Type: FlowService
• Dynamic: ❓
• Required: ❌

gitDirectory

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: _flows

Directory from which flows should be synced.

If not set, this task assumes your branch has a Git directory named _flows (equivalent to the default gitDirectory of the PushFlows task).

If includeChildNamespaces property is set to true, this task will push all flows from nested subdirectories into their corresponding child namespaces, e.g. if targetNamespace is set to prod, then:

• flows from the _flows directory will be synced to the prod namespace,
• flows from the _flows/marketing subdirectory in Git will be synced to the prod.marketing namespace,
• flows from the _flows/marketing/crm subdirectory will be synced to the prod.marketing.crm namespace.

includeChildNamespaces

• Type: boolean
• Dynamic: ✔️
• Required: ❌
• Default: false

Whether you want to sync flows from child namespaces as well.

It’s false by default so that we sync only flows from the explicitly declared gitDirectory without traversing child directories. If set to true, flows from subdirectories in Git will be synced to child namespace in Kestra using the dot notation . for each subdirectory in the folder structure.

passphrase

• Type: string
• Dynamic: ✔️
• Required: ❌

The passphrase for the privateKey.

password

• Type: string
• Dynamic: ✔️
• Required: ❌

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).

privateKey

• Type: string
• Dynamic: ✔️
• Required: ❌

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.

url

• Type: string
• Dynamic: ✔️
• Required: ❌

The URI to clone from.

username

• Type: string
• Dynamic: ✔️
• Required: ❌

The username or organization.

Definitions

io.kestra.core.services.FlowService

Properties