Git SyncUnitTests

Git SyncUnitTests
Certified
Enterprise Edition
Sync Unit Tests from Git to Kestra

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

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

Examples

Sync unit tests from a Git repository. This flow can run on a schedule or on webhook triggers.

yaml
id: sync_unit_tests
namespace: company.team

tasks:
  - id: git
    type: io.kestra.plugin.ee.git.SyncUnitTests
    delete: true
    url: https://github.com/fdelbrayelle/plugin-git-qa
    branch: dev
    username: fdelbrayelle
    password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"

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

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

branch string

Defaultmain

The branch from which unit tests will be synced to Kestra

cloneSubmodules booleanstring

Whether to clone submodules

delete booleanstring

Defaultfalse

Whether you want to delete unit tests present in Kestra but not present in Git

It’s false by default to avoid destructive behavior. Use with caution.

dryRun booleanstring

Defaultfalse

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

failOnMissingDirectory booleanstring

Defaulttrue

If true (default), the task will fail if the specified directory doesn't exist. If false, missing directories will be skipped

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_unit_tests

Directory from which unit tests should be synced

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.

namespace string

The namespace to sync unit tests to

If set, unit tests are deployed to this namespace, overriding the namespace declared in the suite YAML (the declared namespace can then be omitted). Only unit tests in this namespace and its child namespaces are considered, and with delete enabled only those unit tests are eligible for deletion. The flow each suite targets (flowId) must exist in this namespace. If left empty, suites keep the namespace declared in their YAML and the task operates across all namespaces (the previous behavior).

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