Skip to content

Commit 3dfae61

Browse files
committed
Update git-clone.md
Ported depth field description from Classic for shallow clone
1 parent 3792a3b commit 3dfae61

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

_docs/pipelines/steps/git-clone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ step_name:
5555
| `git` | The name of the [git integration]({{site.baseurl}}/docs/integrations/git-providers/) you want to use. If left empty, Codefresh will attempt to use the git provider that was used during account sign-up. Note that this might have unexpected results if you are changing your Git integrations.| Required|
5656
| `repo` | path of the repository without the domain name in the form of `my_username/my_repo` | Required |
5757
| `revision` | The revision of the repository you are checking out. It can be a revision hash or a branch name. The default value is the branch you have specified in your Git provider (e.g `master` or `main`). | Default |
58+
`depth` | The number of commits to pull from the repo to create a shallow clone. Creating a shallow clone truncates the history to the number of commits specified, instead of pulling the entire history. | Optional |
5859
| `use_proxy` | If set to true the Git clone process will honor `HTTP_PROXY` and `HTTPS_PROXY` variables if present for [working via a proxy](#using-git-behind-a-proxy). Default value is `false`. | Default |
5960
| `credentials` | Credentials to access the repository, if it requires authentication. It can an object containing `username` and `password` fields. Credentials are optional if you are using the [built-in git integrations]({{site.baseurl}}/docs/integrations/git-providers/) . | Optional |
6061
| `fail_fast` | If a step fails and the process is halted. The default value is `true`. | Default |

0 commit comments

Comments
 (0)