Update website/docs/language/modules/sources.mdx

Co-authored-by: runephilosof-karnovgroup <101270124+runephilosof-karnovgroup@users.noreply.github.com>
pull/34692/head
Vinod Kumar 2 years ago committed by GitHub
parent e6cc1e59ec
commit dfcb6ea266
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -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),

Loading…
Cancel
Save