---
properties:
  - name: branch
    description: |
      Change branch name.
    type: string
    defaultvalue: "main"
    required: false

  - name: commit_ref
    description: |
      Git commit ref.
    type: string
    defaultvalue: "refs/heads/main"
    required: false

  - name: commit_sha
    description: |
      Git commit sha.
    type: string
    defaultvalue: $CI_COMMIT_SHA
    required: false

  - name: depth
    description: |
      Clone depth.
    type: integer
    defaultvalue: 0
    required: false

  - name: insecure_skip_ssl_verify
    description: |
      Skip SSL verification of the remote machine.

      Activating this option is insecure and should be avoided in most cases.
    type: bool
    defaultvalue: false
    required: false

  - name: lfs
    description: |
      Whether to retrieve LFS content if available.
    type: bool
    defaultvalue: true
    required: false

  - name: partial
    description: |
      Enable/disable partial clone.
    type: bool
    defaultvalue: false
    required: false

  - name: recursive
    description: |
      Clone submodules.
    type: bool
    defaultvalue: true
    required: false

  - name: remote
    description: |
      Git remote HTTP clone url.
    type: string
    defaultvalue: $CI_REPO_CLONE_URL
    required: false

  - name: remote_ssh
    description: |
      Git remote SSH clone url.
    type: string
    defaultvalue: $CI_REPO_CLONE_SSH_URL
    required: false

  - name: safe_directory
    description: |
      Define/replace safe directories.
    type: string
    defaultvalue: $CI_WORKSPACE
    required: false

  - name: ssh_key
    description: |
      Private key for SSH clone.
    type: string
    required: false

  - name: submodule_override
    description: |
      JSON map of submodule overrides.
    type: generic
    required: false

  - name: submodules_partial
    description: |
      Update submodules via partial clone (`depth=1`).
    type: bool
    defaultvalue: true
    required: false

  - name: submodules_update_remote
    description: |
      Update remote submodules.
    type: bool
    defaultvalue: false
    required: false

  - name: tags
    description: |
      Fetch git tags during clone.
    type: bool
    defaultvalue: true
    required: false

  - name: use_ssh
    description: |
      Using SSH for git clone.
    type: bool
    defaultvalue: false
    required: false

  - name: workdir
    description: |
      Path to clone git repository.
    type: string
    defaultvalue: $CI_WORKSPACE
    required: false