Skip to content

Commit 65231c3

Browse files
rkoron007mjyocca
andauthored
Update content/terraform-docs-common/docs/cloud-docs/registry/using.mdx
Co-authored-by: Michael Yocca <19916665+mjyocca@users.noreply.github.com>
1 parent c687375 commit 65231c3

File tree

1 file changed

+9
-2
lines changed
  • content/terraform-docs-common/docs/cloud-docs/registry

1 file changed

+9
-2
lines changed

content/terraform-docs-common/docs/cloud-docs/registry/using.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,15 @@ To learn more about specific syntax for providers in components, refer to [`prov
190190

191191
Each `component` block specifies the Terraform module to use as the source for that component.
192192

193-
To source a module from Github, use the following syntax:
194-
`git::ssh://github.com/<ORGANIZATION_NAME>/repository.git/<SUB-PATH-TO-YOUR-MODULE>`. The following example sources a module named `kube` from a GitHub repository:
193+
To source a module from a Remote Git address, use the following syntax:
194+
`git::<protocol>://<hostname>/<resource-path>.git//path/to/dir?ref=<git reference>`.
195+
196+
Additional Details:
197+
- Supported protocols are HTTP/HTTPS and SSH.
198+
- Userinfo is not allowed in the URL (username & password).
199+
- Valid Refs (`?ref=`) include: Full commit sha, Git Tag, and Branch name.
200+
201+
The following example sources a module named `kube` from a GitHub repository:
195202

196203
```hcl
197204
component "my-component" {

0 commit comments

Comments
 (0)