Skip to content

Commit 0504da2

Browse files
docs: replace '.. rest of config ..' with explicit repo selection fields in auth examples (#982)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 29c93e6 commit 0504da2

File tree

8 files changed

+75
-30
lines changed

8 files changed

+75
-30
lines changed

docs/docs/connections/ado-cloud.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,11 @@ Next, provide the access [token](/docs/configuration/config-file#tokens) via an
100100
// note: this env var can be named anything. It
101101
// doesn't need to be `ADO_TOKEN`.
102102
"env": "ADO_TOKEN"
103-
}
104-
// .. rest of config ..
103+
},
104+
// At least one of the following is required to specify which repos to sync:
105+
"repos": ["organizationName/projectName/repoName"],
106+
// "orgs": ["organizationName"],
107+
// "projects": ["organizationName/projectName"]
105108
}
106109
```
107110

docs/docs/connections/ado-server.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,11 @@ Next, provide the access [token](/docs/configuration/config-file#tokens) via an
114114
// note: this env var can be named anything. It
115115
// doesn't need to be `ADO_TOKEN`.
116116
"env": "ADO_TOKEN"
117-
}
118-
// .. rest of config ..
117+
},
118+
// At least one of the following is required to specify which repos to sync:
119+
"repos": ["collectionName/projectName/repoName"],
120+
// "orgs": ["collectionName"],
121+
// "projects": ["collectionName/projectName"]
119122
}
120123
```
121124

docs/docs/connections/bitbucket-cloud.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,11 @@ In order to index private repositories, you'll need to provide authentication cr
102102
// note: this env var can be named anything. It
103103
// doesn't need to be `BITBUCKET_TOKEN`.
104104
"env": "BITBUCKET_TOKEN"
105-
}
106-
// .. rest of config ..
105+
},
106+
// At least one of the following is required to specify which repos to sync:
107+
"repos": ["myWorkspace/myRepo"],
108+
// "workspaces": ["myWorkspace"],
109+
// "projects": ["myProject"]
107110
}
108111
```
109112

@@ -130,8 +133,11 @@ In order to index private repositories, you'll need to provide authentication cr
130133
// note: this env var can be named anything. It
131134
// doesn't need to be `BITBUCKET_TOKEN`.
132135
"env": "BITBUCKET_TOKEN"
133-
}
134-
// .. rest of config ..
136+
},
137+
// At least one of the following is required to specify which repos to sync:
138+
"repos": ["myWorkspace/myRepo"],
139+
// "workspaces": ["myWorkspace"],
140+
// "projects": ["myProject"]
135141
}
136142
```
137143

@@ -164,8 +170,11 @@ In order to index private repositories, you'll need to provide authentication cr
164170
// note: this env var can be named anything. It
165171
// doesn't need to be `BITBUCKET_TOKEN`.
166172
"env": "BITBUCKET_TOKEN"
167-
}
168-
// .. rest of config ..
173+
},
174+
// At least one of the following is required to specify which repos to sync:
175+
"repos": ["myWorkspace/myRepo"],
176+
// "workspaces": ["myWorkspace"],
177+
// "projects": ["myProject"]
169178
}
170179
```
171180

docs/docs/connections/bitbucket-data-center.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,11 @@ In order to index private repositories, you'll need to provide a [HTTP Access To
104104
// note: this env var can be named anything. It
105105
// doesn't need to be `BITBUCKET_TOKEN`.
106106
"env": "BITBUCKET_TOKEN"
107-
}
108-
// .. rest of config ..
107+
},
108+
// At least one of the following is required to specify which repos to sync:
109+
"repos": ["myProject/myRepo"],
110+
// "projects": ["myProject"],
111+
// "all": true
109112
}
110113
```
111114

@@ -134,8 +137,11 @@ In order to index private repositories, you'll need to provide a [HTTP Access To
134137
// note: this env var can be named anything. It
135138
// doesn't need to be `BITBUCKET_TOKEN`.
136139
"env": "BITBUCKET_TOKEN"
137-
}
138-
// .. rest of config ..
140+
},
141+
// At least one of the following is required to specify which repos to sync:
142+
"repos": ["myProject/myRepo"],
143+
// "projects": ["myProject"],
144+
// "all": true
139145
}
140146
```
141147

docs/docs/connections/gerrit.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ To connect to a gerrit instance, provide the `url` property to your config:
1919
```json
2020
{
2121
"type": "gerrit",
22-
"url": "https://gerrit.example.com"
23-
// .. rest of config ..
22+
"url": "https://gerrit.example.com",
23+
// Specify which projects to sync using glob patterns:
24+
"projects": ["project1/**"]
2425
}
2526
```
2627

docs/docs/connections/gitea.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,11 @@ Next, provide the access token via an environment variable [token](/docs/configu
9494
// note: this env var can be named anything. It
9595
// doesn't need to be `GITEA_TOKEN`.
9696
"env": "GITEA_TOKEN"
97-
}
98-
// .. rest of config ..
97+
},
98+
// At least one of the following is required to specify which repos to sync:
99+
"repos": ["my-org/myRepo"],
100+
// "orgs": ["my-org"],
101+
// "users": ["my-user"]
99102
}
100103
```
101104

@@ -116,8 +119,11 @@ To connect to a custom Gitea deployment, provide the `url` property to your conf
116119
```json
117120
{
118121
"type": "gitea",
119-
"url": "https://gitea.example.com"
120-
// .. rest of config ..
122+
"url": "https://gitea.example.com",
123+
// At least one of the following is required to specify which repos to sync:
124+
"repos": ["my-org/myRepo"],
125+
// "orgs": ["my-org"],
126+
// "users": ["my-user"]
121127
}
122128
```
123129

docs/docs/connections/github.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,11 @@ In order to index private repositories, you'll need to authenticate with GitHub.
172172
// note: this env var can be named anything. It
173173
// doesn't need to be `GITHUB_TOKEN`.
174174
"env": "GITHUB_TOKEN"
175-
}
176-
// .. rest of config ..
175+
},
176+
// At least one of the following is required to specify which repos to sync:
177+
"repos": ["my-org/myRepo"],
178+
// "orgs": ["my-org"],
179+
// "users": ["my-user"]
177180
}
178181
```
179182
</Step>
@@ -203,8 +206,11 @@ In order to index private repositories, you'll need to authenticate with GitHub.
203206
// note: this env var can be named anything. It
204207
// doesn't need to be `GITHUB_TOKEN`.
205208
"env": "GITHUB_TOKEN"
206-
}
207-
// .. rest of config ..
209+
},
210+
// At least one of the following is required to specify which repos to sync:
211+
"repos": ["my-org/myRepo"],
212+
// "orgs": ["my-org"],
213+
// "users": ["my-user"]
208214
}
209215
```
210216
</Step>
@@ -222,8 +228,11 @@ To connect to a GitHub host other than `github.com`, provide the `url` property
222228
```json
223229
{
224230
"type": "github",
225-
"url": "https://github.example.com"
226-
// .. rest of config ..
231+
"url": "https://github.example.com",
232+
// At least one of the following is required to specify which repos to sync:
233+
"repos": ["my-org/myRepo"],
234+
// "orgs": ["my-org"],
235+
// "users": ["my-user"]
227236
}
228237
```
229238

docs/docs/connections/gitlab.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,12 @@ Next, provide the PAT via an environment variable [token](/docs/configuration/co
129129
// note: this env var can be named anything. It
130130
// doesn't need to be `GITLAB_TOKEN`.
131131
"env": "GITLAB_TOKEN"
132-
}
133-
// .. rest of config ..
132+
},
133+
// At least one of the following is required to specify which projects to sync:
134+
"projects": ["my-group/myProject"],
135+
// "groups": ["my-group"],
136+
// "users": ["my-user"],
137+
// "all": true (self-managed only)
134138
}
135139
```
136140

@@ -151,8 +155,12 @@ To connect to a GitLab host other than `gitlab.com`, provide the `url` property
151155
```json
152156
{
153157
"type": "gitlab",
154-
"url": "https://gitlab.example.com"
155-
// .. rest of config ..
158+
"url": "https://gitlab.example.com",
159+
// At least one of the following is required to specify which projects to sync:
160+
"projects": ["my-group/myProject"],
161+
// "groups": ["my-group"],
162+
// "users": ["my-user"],
163+
// "all": true
156164
}
157165
```
158166

0 commit comments

Comments
 (0)