From dfcb6ea2663e3ebbf85a4422f1d69b6b644acde4 Mon Sep 17 00:00:00 2001 From: Vinod Kumar <24762720+vinod827@users.noreply.github.com> Date: Mon, 19 Feb 2024 21:03:24 +0530 Subject: [PATCH] Update website/docs/language/modules/sources.mdx Co-authored-by: runephilosof-karnovgroup <101270124+runephilosof-karnovgroup@users.noreply.github.com> --- website/docs/language/modules/sources.mdx | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/website/docs/language/modules/sources.mdx b/website/docs/language/modules/sources.mdx index eb637e3de6..bd026afcdd 100644 --- a/website/docs/language/modules/sources.mdx +++ b/website/docs/language/modules/sources.mdx @@ -263,10 +263,15 @@ to reduce the time taken to retrieve the remote repository. The `depth` URL argument corresponds to [the `--depth` argument to `git clone`](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt), instructs the Git to create a shallow clone with the history truncated to only -the specified number of commits. For example, if you want to perform a shallow clone with only the last 3 commits -of a repository, you would use the `--depth=3` parameter in the clone URL -like git::https://example.com/vpc.git?depth=3&ref=v1.2.0. This would fetch only the most recent 3 commits along with -the necessary data, making the clone faster and more efficient, especially for large repositories. +the specified number of commits. +Because Terraform only uses the most recent selected commit to find the source +code of your specified module, it is not typically useful to set `depth` +to any value other than `1`. +```hcl +module "vpc" { + source = "git::https://example.com/vpc.git?depth=1&ref=v1.2.0" +} +``` However, because shallow clone requires different Git protocol behavior, setting the `depth` argument makes Terraform pass your [`ref` argument](#selecting-a-revision),