Skip to content

Commit a9a7001

Browse files
committed
Update admin/code_hosts/gerrit.schema.json schema for v6.5.1211
1 parent 510bb30 commit a9a7001

File tree

1 file changed

+49
-20
lines changed

1 file changed

+49
-20
lines changed

docs/admin/code_hosts/gerrit.mdx

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -110,51 +110,80 @@ Gerrit connections support the following configuration options, which are specif
110110

111111
{/* SCHEMA_SYNC_START: admin/code_hosts/gerrit.schema.json */}
112112
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
113-
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
113+
{/* Last updated: 2025-07-01T23:25:37Z via sourcegraph/sourcegraph@v6.5.1211 */}
114114
```json
115115
{
116116
// If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`.
117-
"authorization": null,
117+
"authorization": {
118+
"identityProvider": null
119+
},
118120

121+
// A list of repositories to never mirror from this Gerrit instance. Takes precedence over "projects" configuration.
122+
// Supports excluding by name ({"name": "owner/name"})
123+
// Other example values:
124+
// - [
125+
// {
126+
// "name": "docs"
127+
// },
128+
// {
129+
// "name": "php/php-src"
130+
// }
131+
// ]
132+
"exclude": null,
133+
134+
// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
135+
"gitSSHCipher": null,
136+
137+
// SSH keys to use when cloning Git repo.
138+
"gitSSHCredential": null,
139+
140+
// The type of Git URLs to use for cloning and fetching Git repositories on this Gerrit instance.
141+
// If "http", Sourcegraph will access Gerrit repositories using Git URLs of the form http(s)://gerrit.example.com/a/myteam/myproject.git (using https: if the Gerrit instance uses HTTPS).
142+
// If "ssh", Sourcegraph will access Gerrit repositories using Git URLs of the form [email protected]:myteam/myproject.git. The exact hostname and port will be fetched from /ssh_info. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.
143+
// Valid options: "http", "ssh"
144+
"gitURLType": "http",
145+
146+
// REQUIRED:
119147
// The password associated with the Gerrit username used for authentication.
120148
"password": null,
121149

150+
// Any number of query parameters as supported by the Gerrit REST API: https://gerrit-review.googlesource.com/Documentation/rest-api-projects.html
151+
// Other example values:
152+
// - "query=name:kubernetes"
153+
// - "r=.*test"
154+
"projectQuery": null,
155+
122156
// An array of project strings specifying which Gerrit projects to mirror on Sourcegraph. If empty, all projects will be mirrored.
123-
"projects": null,
124157
// Other example values:
125-
// - ["name","owner/name"]
158+
// - [
159+
// "name",
160+
// "owner/name"
161+
// ]
126162
// - [
127163
// "docs",
128164
// "kubernetes/kubernetes",
129165
// "golang/go",
130166
// "facebook/react"
131167
// ]
168+
"projects": null,
132169

133-
// A list of repositories to never mirror from this Gerrit instance. Takes precedence over \"projects\" configuration.
134-
//
135-
// Supports excluding by name ({"name": "owner/name"})
136-
"exclude": null,
137-
// Other example values:
138-
// - [
139-
// {
140-
// "name": "docs"
141-
// },
142-
// {
143-
// "name": "php/php-src"
144-
// }
145-
// ]
170+
// The pattern used to generate the corresponding Sourcegraph repository name for a Gerrit repository. In the pattern, the variable "{host}" is replaced with the Gerrit host (such as gerrit.example.com), and "{name}" is replaced with the Gerrit repository's name (such as "myrepo").
171+
// For example, if your Gerrit URL is https://gerrit.example.com and your Sourcegraph URL is https://src.example.com, then a repositoryPathPattern of "{host}/{name}" would mean that a Gerrit repository at https://gerrit.example.com/myrepo is available on Sourcegraph at https://src.example.com/gerrit.example.com/myrepo.
172+
// 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.
173+
"repositoryPathPattern": "{host}/{name}",
146174

175+
// REQUIRED:
147176
// URL of a Gerrit instance, such as https://gerrit.example.com.
148-
"url": null,
149177
// Other example values:
150178
// - "https://gerrit.example.com"
179+
"url": null,
151180

152-
// A username for authentication withe the Gerrit code host.
181+
// REQUIRED:
182+
// A username for authentication with the Gerrit code host.
153183
"username": null
154184
}
155185
```
156186
{/* SCHEMA_SYNC_END: admin/code_hosts/gerrit.schema.json */}
157-
158187
## Configuration Notes
159188

160189
### HTTP Credentials Setup

0 commit comments

Comments
 (0)