Skip to content

Commit 2676003

Browse files
committed
Update admin/code_hosts/gitlab.schema.json schema for v6.5.1211
1 parent 1a11701 commit 2676003

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

docs/admin/code_hosts/gitlab.mdx

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -187,25 +187,22 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).
187187

188188
{/* SCHEMA_SYNC_START: admin/code_hosts/gitlab.schema.json */}
189189
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
190-
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
190+
{/* Last updated: 2025-07-01T23:25:33Z via sourcegraph/sourcegraph@v6.5.1211 */}
191191
```json
192192
{
193193
// If non-null, enforces GitLab repository permissions. This requires that there be an item in the `auth.providers` field of type "gitlab" with the same `url` field as specified in this `GitLabConnection`.
194-
"authorization": null,
194+
"authorization": {
195+
"identityProvider": {
196+
"type": null
197+
}
198+
},
195199

196200
// TLS certificate of the GitLab instance. This is only necessary if the certificate is self-signed or signed by an internal CA. To get the certificate run `openssl s_client -connect HOST:443 -showcerts < /dev/null 2> /dev/null | openssl x509 -outform PEM`. To escape the value into a JSON string, you may want to use a tool like https://json-escape-text.now.sh.
197-
"certificate": null,
198201
// Other example values:
199202
// - "-----BEGIN CERTIFICATE-----\n..."
203+
"certificate": null,
200204

201-
// Only used to override the cloud_default column from a config file specified by EXTSVC_CONFIG_FILE
202-
"cloudDefault": false,
203-
204-
// When set to true, this external service will be chosen as our 'Global' GitLab service. Only valid on Sourcegraph.com. Only one service can have this flag set.
205-
"cloudGlobal": false,
206-
207-
// A list of projects to never mirror from this GitLab instance. Takes precedence over \"projects\" and \"projectQuery\" configuration. You can exclude projects by: name ({"name": "group/name"}), ID ({"id": 42}), regular expression matching pattern ({"pattern": "^group/project-.*"}), or by excluding empty repositories ({"emptyRepos": true}).
208-
"exclude": null,
205+
// A list of projects to never mirror from this GitLab instance. Takes precedence over "projects" and "projectQuery" configuration. You can exclude projects by: name ({"name": "group/name"}), ID ({"id": 42}), regular expression matching pattern ({"pattern": "^group\/project-.*"}), or by excluding empty repositories ({"emptyRepos": true}).
209206
// Other example values:
210207
// - [
211208
// {
@@ -226,22 +223,30 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).
226223
// "name": "gitlab-com/www-gitlab-com"
227224
// }
228225
// ]
226+
"exclude": null,
227+
228+
// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
229+
"gitSSHCipher": null,
230+
231+
// SSH keys to use when cloning Git repo.
232+
"gitSSHCredential": null,
229233

230234
// The type of Git URLs to use for cloning and fetching Git repositories on this GitLab instance.
231-
//
232235
// If "http", Sourcegraph will access GitLab repositories using Git URLs of the form http(s)://gitlab.example.com/myteam/myproject.git (using https: if the GitLab instance uses HTTPS).
233-
//
234236
// If "ssh", Sourcegraph will access GitLab repositories using Git URLs of the form [email protected]:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.
237+
// Valid options: "http", "ssh"
235238
"gitURLType": "http",
236239

237240
// Deprecated and ignored field which will be removed entirely in the next release. GitLab repositories can no longer be enabled or disabled explicitly.
238-
"initialRepositoryEnablement": null,
241+
"initialRepositoryEnablement": false,
239242

240243
// If true, internal repositories will be accessible to all users on Sourcegraph as if they were public, and user permission syncs will no longer check for public repositories. This overrides repository permissions but allows easier discovery and access to internal repositories, and may be desirable if all users on the Sourcegraph instance should have access to all internal repositories anyways. Defaults to false.
241244
"markInternalReposAsPublic": false,
242245

246+
// The maximum number of repos that will be deleted per sync. A value of 0 or less indicates no maximum.
247+
"maxDeletions": 0,
248+
243249
// An array of transformations will apply to the repository name. Currently, only regex replacement is supported. All transformations happen after "repositoryPathPattern" is processed.
244-
"nameTransformations": null,
245250
// Other example values:
246251
// - [
247252
// {
@@ -253,21 +258,21 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).
253258
// "replacement": ""
254259
// }
255260
// ]
261+
"nameTransformations": null,
256262

263+
// REQUIRED:
257264
// An array of strings specifying which GitLab projects to mirror on Sourcegraph. Each string is a URL path and query that targets a GitLab API endpoint returning a list of projects. If the string only contains a query, then "projects" is used as the path. Examples: "?membership=true&search=foo", "groups/mygroup/projects".
258-
//
259265
// The special string "none" can be used as the only element to disable this feature. Projects matched by multiple query strings are only imported once. Here are a few endpoints that return a list of projects: https://docs.gitlab.com/ee/api/projects.html#list-all-projects, https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects, https://docs.gitlab.com/ee/api/search.html#scope-projects.
260-
"projectQuery": [
261-
"none"
262-
],
263266
// Other example values:
264267
// - [
265268
// "?membership=true\u0026search=foo",
266269
// "groups/mygroup/projects"
267270
// ]
271+
"projectQuery": [
272+
"none"
273+
],
268274

269275
// A list of projects to mirror from this GitLab instance. Supports including by name ({"name": "group/name"}) or by ID ({"id": 42}).
270-
"projects": null,
271276
// Other example values:
272277
// - [
273278
// {
@@ -285,6 +290,7 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).
285290
// "name": "gitlab-org/gitlab-ce"
286291
// }
287292
// ]
293+
"projects": null,
288294

289295
// Rate limit applied when making background API requests to GitLab.
290296
"rateLimit": {
@@ -293,36 +299,37 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).
293299
},
294300

295301
// The pattern used to generate a the corresponding Sourcegraph repository name for a GitLab project. In the pattern, the variable "{host}" is replaced with the GitLab URL's host (such as gitlab.example.com), and "{pathWithNamespace}" is replaced with the GitLab project's "namespace/path" (such as "myteam/myproject").
296-
//
297302
// For example, if your GitLab is https://gitlab.example.com and your Sourcegraph is https://src.example.com, then a repositoryPathPattern of "{host}/{pathWithNamespace}" would mean that a GitLab project at https://gitlab.example.com/myteam/myproject is available on Sourcegraph at https://src.example.com/gitlab.example.com/myteam/myproject.
298-
//
299303
// It is important that the Sourcegraph repository name generated with this pattern be unique to this code host. If different code hosts generate repository names that collide, Sourcegraph's behavior is undefined.
300304
"repositoryPathPattern": "{host}/{pathWithNamespace}",
301305

302-
// A GitLab access token with "api" scope. Can be a personal access token (PAT) or an OAuth token. If you are enabling permissions with identity provider type "external", this token should also have "sudo" scope.
306+
// REQUIRED:
307+
// A GitLab access token with "api" scope. Can be a personal access token (PAT) or an OAuth token. If you are enabling permissions with identity provider type "username", this token should also have "sudo" scope.
303308
"token": null,
304309

305310
// The OAuth token expiry (Unix timestamp in seconds)
306-
"token.oauth.expiry": null,
311+
"token.oauth.expiry": 0,
307312

308313
// The OAuth refresh token
309314
"token.oauth.refresh": null,
310315

311316
// The type of the token
317+
// Valid options: "pat", "oauth"
312318
"token.type": "pat",
313319

320+
// REQUIRED:
314321
// URL of a GitLab instance, such as https://gitlab.example.com or (for GitLab.com) https://gitlab.com.
315-
"url": null,
316322
// Other example values:
317323
// - "https://gitlab.com"
318324
// - "https://gitlab.example.com"
325+
"url": null,
319326

327+
// ⚠️ DEPRECATED: Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice
320328
// An array of webhook configurations
321329
"webhooks": null
322330
}
323331
```
324332
{/* SCHEMA_SYNC_END: admin/code_hosts/gitlab.schema.json */}
325-
326333
## Native integration
327334

328335
To provide out-of-the-box code navigation features to your users on GitLab, you will need to [configure your GitLab instance](https://docs.gitlab.com/ee/integration/sourcegraph.html). If you are using an HTTPS connection to GitLab, you will need to [configure HTTPS](/admin/http_https_configuration) for your Sourcegraph instance.

0 commit comments

Comments
 (0)