PLUGINSPLUGIN-GITTASKSIO.KESTRA.PLUGIN.GIT.CLONE

​Clone

Clone Clone

yaml
type: "io.kestra.plugin.git.Clone"

Clone a repository

Examples

Clone a repository from http server

yaml
id: "clone"
type: "io.kestra.plugin.git.Clone"
url: https://github.com/kestra-io/plugin-template
branch: develop
username: <username>
password: <password>

Clone a repository from ssh server

yaml
id: "clone"
type: "io.kestra.plugin.git.Clone"
url: git@github.com:kestra-io/kestra.git
directory: kestra
privateKey: <keyfile>
passphrase: <passphrase>

Clone a repository from http server with a personal access token

yaml
id: "clone"
type: "io.kestra.plugin.git.Clone"
url: https://github.com/kestra-io/plugin-template
branch: develop
username: <username>
password: <personnalAccessToken>

Properties

url

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

The URI to clone from

branch

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

The initial branch

cloneSubmodules

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

Whether to clone submodules.

depth

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 1
  • Minimum: &gt;= 1

Creates a shallow clone with a history truncated to the specified number of commits.

directory

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

The optional directory associated with the clone operation.

If the directory isn't set, the current dir will be used.

passphrase

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

The passphrase for the privateKey

password

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

The password used to connect

privateKey

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

The private keyfile used to connect

username

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

The username used to connect

Outputs

directory

  • Type: string

Short description for this output

Full description of this output