Skip to content

Commit 1d5f6c6

Browse files
Copilotnitrocode
andauthored
docs: fix remaining documentation issues from PR #2245 review
Agent-Logs-Url: https://github.com/cloudposse/atmos/sessions/bc75a042-a0e2-438d-ab72-433d1c692636 Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
1 parent ad09c3d commit 1d5f6c6

File tree

4 files changed

+17
-13
lines changed

4 files changed

+17
-13
lines changed

website/docs/cli/configuration-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ spec:
141141
sources:
142142
- component: vpc
143143
source: github.com/cloudposse-terraform-components/aws-vpc.git//src
144-
version: 1.300.0
144+
version: "v1.537.0"
145145
```
146146

147147
[Learn more about Vendoring →](/vendor/)

website/docs/vendor/component-manifest/source.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ spec:
3939

4040
To vendor a module from a Git repo, use the following format:
4141
```
42-
github.com/cloudposse-terraform-components/aws-vpc.git//src?ref={{.Version}}
42+
github.com/cloudposse-terraform-components/aws-<component>.git//src?ref={{.Version}}
4343
```
4444
</dd>
4545

website/docs/vendor/config/imports.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ spec:
149149
sources:
150150
- component: "my-vpc4"
151151
source: "github.com/cloudposse-terraform-components/aws-vpc.git//src?ref={{.Version}}"
152-
version: "1.535.0"
152+
version: "v1.535.0"
153153
targets:
154154
- "components/terraform/infra/my-vpc4"
155155
```
@@ -170,11 +170,11 @@ are defined:
170170
> atmos vendor pull
171171
172172
Processing vendor config file 'vendor.yaml'
173-
Pulling sources for the component 'my-vpc6' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=1.533.0' into 'components/terraform/infra/my-vpc6'
174-
Pulling sources for the component 'my-vpc5' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=1.534.0' into 'components/terraform/infra/my-vpc5'
175-
Pulling sources for the component 'my-vpc4' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=1.535.0' into 'components/terraform/infra/my-vpc4'
173+
Pulling sources for the component 'my-vpc6' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.533.0' into 'components/terraform/infra/my-vpc6'
174+
Pulling sources for the component 'my-vpc5' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.534.0' into 'components/terraform/infra/my-vpc5'
175+
Pulling sources for the component 'my-vpc4' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.535.0' into 'components/terraform/infra/my-vpc4'
176176
Pulling sources for the component 'my-vpc1' from 'public.ecr.aws/cloudposse/components/terraform/stable/aws/vpc:1.0.2' into 'components/terraform/infra/my-vpc1'
177-
Pulling sources for the component 'my-vpc2' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=1.536.0' into 'components/terraform/infra/my-vpc2'
177+
Pulling sources for the component 'my-vpc2' from 'github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.536.0' into 'components/terraform/infra/my-vpc2'
178178
Pulling sources for the component 'vpc' from 'public.ecr.aws/cloudposse/components/terraform/stable/aws/vpc:latest' into 'components/terraform/infra/vpc3'
179179
Pulling sources for the component 'vpc-flow-logs-bucket' from 'github.com/cloudposse-terraform-components/aws-vpc-flow-logs-bucket.git//src?ref=v1.537.0' into 'components/terraform/infra/vpc-flow-logs-bucket/v1.537.0'
180180
```

website/docs/vendor/url-syntax.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ The double-slash (`//`) is a special delimiter (not a path separator) that separ
5656

5757
<TabItem value="root" label="Root Directory">
5858
```yaml
59-
source: "github.com/cloudposse-terraform-components/aws-s3-bucket.git//.?ref=v1.541.1"
59+
source: "github.com/cloudposse-terraform-components/aws-s3-bucket.git//src?ref=v1.541.1"
6060
```
6161

62-
**Result:** Clones the repository and uses the root directory (`.` means current directory).
62+
**Result:** Clones the repository and extracts the `src` subdirectory (where Terraform files reside in `cloudposse-terraform-components` repos).
6363
</TabItem>
6464

6565
<TabItem value="no-delimiter" label="Without Delimiter">
@@ -68,6 +68,10 @@ The double-slash (`//`) is a special delimiter (not a path separator) that separ
6868
```
6969

7070
**Result:** For Git URLs without a subdirectory, Atmos automatically adds `//.` for you (root of repository).
71+
72+
:::caution cloudposse-terraform-components repos
73+
For `cloudposse-terraform-components` repos, always specify `//src` explicitly — Terraform files reside in the `src/` subdirectory, not the repository root.
74+
:::
7175
</TabItem>
7276
</Tabs>
7377

@@ -126,13 +130,13 @@ Atmos automatically adds `depth=1` to Git clones for faster downloads. You can o
126130

127131
<TabItem value="commit" label="Git Commit SHA">
128132
```yaml
129-
source: "github.com/cloudposse-terraform-components/aws-vpc.git?ref=a1b2c3d4"
133+
source: "github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=a1b2c3d4"
130134
```
131135
</TabItem>
132136

133137
<TabItem value="depth" label="Custom Clone Depth">
134138
```yaml
135-
source: "github.com/cloudposse-terraform-components/aws-vpc.git?ref=main&depth=10"
139+
source: "github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.539.0&depth=10"
136140
```
137141
</TabItem>
138142
</Tabs>
@@ -163,10 +167,10 @@ source: "git::https://github.com/cloudposse/atmos.git//examples?ref=main"
163167
### SSH Authentication
164168
```yaml
165169
# SSH protocol (requires SSH key setup)
166-
source: "git::ssh://git@github.com/cloudposse-terraform-components/aws-vpc.git?ref=v1.539.0"
170+
source: "git::ssh://git@github.com/cloudposse-terraform-components/aws-vpc.git//src?ref=v1.539.0"
167171
168172
# Or SCP-style shorthand
169-
source: "git@github.com:cloudposse-terraform-components/aws-vpc.git?ref=v1.539.0"
173+
source: "git@github.com:cloudposse-terraform-components/aws-vpc.git//src?ref=v1.539.0"
170174
```
171175

172176
### With Credentials (Not Recommended)

0 commit comments

Comments
 (0)