SyncFlow

Sync a single flow from a Git repository to a Kestra namespace.

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

yaml
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 *string

The full path to the flow YAML file within the Git repository.

targetNamespace *string

The target namespace where the flow will be synced.

branch string

Default main

The branch to clone from.

dryRun booleanstring

Default false

If true, the task will only log the action without actually syncing the flow.

passphrase string

The passphrase for the privateKey.

password string

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 string

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 string

The URI to clone from.

username string

The username or organization.

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.

​Sync​Flow

SyncFlow