Git Clone

Clones a git repository onto the runner.

Object Representation (YAML)

id: String
name: String
type: String
depends: [String]
tags: [String]
condition: Boolean
each: Array
verbosity: String
ignore_errors: Boolean
properties:
  url: String
  dest: String
  branch: String
  args: String
  credential: 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.

type *

String

The type of the step. Can be pipeline or a step module type.

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

Boolean

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".

each

Array

An array of elements to execute the step once for each of them.

verbosity

String

Step event verbosity. Determines how much information about step execution is sent back to the application.

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.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.

properties.credential

String

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.

Result Fields

The following are the step execution result fields available at steps.<step id>.result after a step executes.

KeyDetails
result.status

String

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