Git PushBlueprints

Git PushBlueprints
Certified
Enterprise Edition
Commit and push Custom Blueprints from Kestra to Git

Commits custom Blueprints from Kestra to a Git repository and pushes the change.

yaml
type: io.kestra.plugin.ee.git.PushBlueprints

Examples

Push custom blueprints to a Git repository.

yaml
id: push_blueprints
namespace: company.ops
tasks:
  - id: commit_and_push
    type: io.kestra.plugin.ee.git.PushBlueprints
    url: https://github.com/kestra-io/scripts
    username: git_username
    password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    branch: main
    commitMessage: "push blueprints from {{ flow.namespace ~ '.' ~ flow.id }}"

Properties

auth

Kestra API authentication

Definitions

io.kestra.plugin.git.shared.AbstractCloningTask-Auth

apiTokenstring

API token for authentication.

autobooleanstring

Defaulttrue

Automatically retrieve the URL and the credentials from Kestra's configuration if available

Can be configured globally in the Kestra configuration file:

Set kestra.tasks.sdk.authentication.url for the API URL
Set kestra.tasks.sdk.authentication.api-token for API token auth
Set kestra.tasks.sdk.authentication.username and kestra.tasks.sdk.authentication.password for HTTP Basic auth The Enterprise Edition also allows an administrator to set these defaults at the namespace or the tenant level. Set this to false without any credentials to call a Kestra API that requires no authentication.

passwordstring

Password for HTTP Basic authentication.

usernamestring

Username for HTTP Basic authentication.

authorEmail string

Commit author email

If null, no author is set.

authorName string

Commit author name

Defaults to username when empty.

blueprints string

Default**

Which Blueprints should be included in the commit, as glob patterns

branch string

Defaultmain

The branch to which Blueprints should be committed and pushed

If the branch doesn't exist yet, it will be created. If not set, the task will push the files to the main branch.

cloneSubmodules booleanstring

Clone submodules

Default false; enable to fetch and initialize nested submodules.

commitMessage string

DefaultAdd blueprints from {{ flow.id }}

Git commit message

connectTimeout integerstring

Default10000

HTTP connect timeout (ms)

Default 10000 ms.

delete booleanstring

Defaulttrue

Delete removed resources

If true (default), removes Git files that no longer exist in Kestra.

dryRun booleanstring

Defaultfalse

Dry run only

When true, writes a diff file without pushing. Default false pushes immediately.

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)

gitDirectory string

Default_blueprints

Directory to which Blueprints should be pushed

kestraUrl string

Kestra API URL

URL of the Kestra server API. If not set, the URL of the default SDK authentication is used, set with the kestra.tasks.sdk.authentication.url configuration property, or at the namespace or the tenant level on the Enterprise Edition. It then falls back to the kestra.url configuration property, and finally to http://localhost: 8080.

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. Only relevant when strictHostKeyChecking is true.

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) or Contents: Read and Write (push), plus Metadata: Read (mandatory base permission). Add Workflows: Read and Write when pushing .github/workflows/ files.
Classic PAT: repo scope covers all read/write operations; add workflow when pushing workflow files.

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.

pushMode string

DefaultSYNC

Possible Values

SYNCDELETE_ONLY

Push mode

SYNC (default) writes every matched resource to the work tree and stages it, in addition to staging removals when delete is true — this is the standard push behavior, unchanged.

DELETE_ONLY stages only the removal of resources no longer present on the instance: it leaves already-pushed, still-matching resources untouched even if they changed since the last push. Use it to push a deletion without re-pushing unrelated modified resources. DELETE_ONLY implies deletion staging, so setting delete to false together with DELETE_ONLY is ignored (a warning is logged).

readTimeout integerstring

Default60000

HTTP read timeout (ms)

Default 60000 ms.

strictHostKeyChecking booleanstring

Whether to verify the SSH remote server's host key

When enabled, the host key presented by the Git server is verified against knownHosts (if provided) or the system/user known_hosts file. Disabling it exposes the connection to man-in-the-middle attacks (CWE-297). Set knownHosts alongside this property for a hardened setup. The default differs by edition: disabled (false) on Kestra OSS, enabled (true) on Kestra Enterprise Edition.