Git Clone

Clones a git repository onto the runner.

Object Representation (YAML)

id: String
name: String
depends: [String]
tags: [String]
condition: String
ignore_errors: Boolean
properties:
  credential: Credential
  url: String
  dest: String
  branch: String
  args: String

Fields

PropertyDetails
id *

String

A unique identifier for the step.

Can contain hyphens and underscores, but not spaces.

name *

String

A friendly name for the step. This name will appear in the pipeline designer and run output.

depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.

tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.

condition

String

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".

ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.

properties.credential *

Credential

The ID of a credential for authentication with the remote repository. Can be of type Username/Password or SSH Key. If the credential is Username/Password, Basic authentication is used, and the URL should be an HTTP(S) URL. If using an SSH Key credential, the URL should be an SSH URL.

properties.url *

String

HTTP(S) URL of the git repository.

properties.dest *

String

Destination directory where the git respository will be cloned. Relative to the run directory.

properties.branch

String

Branch to checkout. Defaults to master.

properties.args

String

Extra command line arguments to pass to git.

Result Fields

The following are the step execution result fields available at step.result after a step executes.

KeyDetails
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.