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 *

Authentication options

Choose either apiToken or HTTP Basic credentials; mixing both is rejected.

Definitions

io.kestra.plugin.git.AbstractKestraTask-Auth

apiTokenstring

API token

Preferred for server-to-server access; mutually exclusive with username/password.

autobooleanstring

Defaulttrue

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

The default configuration can be configured globally inside the Kestra configuration file:

Set kestra.tasks.sdk.authentication.url to use a given API URL
Set kestra.tasks.sdk.authentication.api-token to use an API token
Set kestra.tasks.sdk.authentication.username and kestra.tasks.sdk.authentication.password for HTTP basic authentication The Enterprise edition also provides setting a default configuration at the Namespace of Tenant level by an administrator.

passwordstring

Password for HTTP Basic authentication

usernamestring

Username for HTTP Basic authentication

authorEmail string

The commit author email

If null, no author will be set on this commit.

authorName string

Default`username`

The commit author name

If null, the username will be used instead.

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

Whether to clone submodules

commitMessage string

DefaultAdd blueprints from {{ flow.id }}

Git commit message

delete booleanstring

Defaulttrue

Whether to delete flows/files from Git that are no longer present in Kestra

If true (default), files present in Git but not in Kestra will be deleted from the Git repository.

dryRun booleanstring

Defaultfalse

If true, the task will only output modifications without pushing any file to Git yet. If false (default), all listed files will be pushed to Git immediately

gitConfig object

Git config applied after clone

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

gitDirectory string

Default_blueprints

Directory to which Blueprints should be pushed

kestraUrl string

Kestra API URL

Rendered first; falls back to the URL of the default SDK authentication, set with the kestra.tasks.sdk.authentication.url configuration property or at the namespace or the tenant level, then to kestra.url from configuration, then 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.

passphrase string

Passphrase for privateKey

password string

Password or personal access token

When set, pushes use the identity tied to this credential, so authorName and authorEmail become optional.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

privateKey string

SSH private key in PEM format

Use an ECDSA/PEM key whose public part is registered on Git. Example: ssh-keygen -t ecdsa -b 256 -m PEM.

strictHostKeyChecking booleanstring

Defaulttrue

Whether to verify the SSH remote server's host key

When true (default), the host key presented by the Git server is verified against knownHosts (if provided) or the system/user known_hosts file, protecting against man-in-the-middle attacks. Only disable this for trusted networks/testing.

url string

Git repository URL

HTTPS or SSH URL used for clone/fetch/push. Supports templating.

username string

Repository username or organization