Versions Compared

Old Version 3

changes.mady.by.user Kostas Papageorgiou

Saved on

compared with

New Version 4

changes.mady.by.user Kostas Papageorgiou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldInput typeDefault valueTypeDescription
ActionRequiredCheckoutChoiceAvailable Action is :
    • CHECKOUT
CheckoutCheckout action clones a Git repository branch locally if the target directory pointed byPathby Path does not exist. The new directory is named after the repository name. If the repository exist in the
Path
      a
Path a git pull <repository><repository> operation is performed to bring the latest revision locally. If differences exist between local and remote repository, the remote repository will overwrite the local directory
Authentication methodRequiredHTTPChoiceAvailable authentication methods are :
  • HTTP/HTTPS (Access Token)
  • HTTP/HTTPS (User and Password)
  • SSH

SSH authentication is available only on Linux Agents.
Repository URLRequired-TextThe repository's url
  • When the authentication method is HTTP/HTTPS (Access Token) or HTTP/HTTPS (User and Password) , the valid format of repository url is : https://host/path/to/repo.git
  • When the authentication method is SSH, the valid format of repository is : user@host/path/to/repo.git
Branch NameRequired-ChoiceThe branch name. A dynamic drop-down list with all the branches from the remote repository. The agent and Credentials on which the task runs on should be specified, so that it looks up the branches on the repository
PathRequired-TextThe local path where the repository directory will be created. The local path resides on the execution environment of the Universal Agent.
Be sure to check your access rights on this location.
Access TokenConditional-CredentialsAccess Token to be used to establish a Token Based authentication. Mandatory only for HTTP/HTTPS (Access Token) authentication method.

The Token field is not available on UAC7.0 or Agents 7.0. Please use the Runtime Password field to enter the Token. There is backwards compatibility from UAC7.1 to UAC7.0
HTTP(S) CredentialsConditional-CredentialsCredentials (User/Password) to be used for HTTP or HTTPS authentication to the Repository Service. Mandatory only for HTTP/HTTPS (User and Password) authentication method
SSH keyConditional-CredentialsSSH Credentials include the Key Location of the Private Key, with chmod permission 400 and a Passphrase if set. Key Location field can be left empty only in case the user requires the key to be retrieved by the default user SSH key location (the user's .ssh folder) and the key is created without a passphrase.

Available only for Linux Agents
Mandatory only for SSH Authentication Method
Accept HostkeyConditionalNoBooleanApplicable only for SSH authentication method. If "No" is selected, ssh will not automatically add host keys to the known_hosts file, and refuses to connect to hosts whose host key has changed. If "Yes" is selected, ssh will automatically add new host keys to the user known_hosts files

...

Checkout action with Access Token

Create Git Task using Access Token method Image RemovedImage Added

Checkout action with HTTP(s) User and Password

Create Git Task using HTTP Authentication method Image RemovedImage Added

Checkout action with SSH

Create Git Task using SSH Authentication method Image RemovedImage Added

Credential Fields

Depending on the Authentication Method (Access Token, SSH, User and Password) use the respective fields as noted in the parenthesis below. Make sure to fill the required fields(*). All fields also can be filled if required.

Credentials Fields Image RemovedImage Added

  • The Token field is not present on UAC7.0 or Agents 7.0. Please use the Runtime Password field instead to enter the Token.

...

After pressing the search icon of branch field , and fill the fields as seen below, wait few second for the branch fields list to be populated. Branch Field Dialog Image Removed

Image Added

Branch Field Choice Population dialog with Access Token

Branch Field Choice dialog using Access Token Authentication method Image RemovedImage Added

Task Output

Exit Codes

...