Skip to content

Add schema sync markers for automated release updates #1210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025
Merged

Add schema sync markers for automated release updates #1210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ab2bae
schema synching foundation
DaedalusG Jun 25, 2025
7370800
mdx idiomatic
DaedalusG Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/aws_codecommit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ AWS CodeCommit connections support the following configuration options, which ar

### admin/code_hosts/aws_codecommit.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/aws_codecommit.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// The AWS access key ID to use when listing and updating repositories from AWS CodeCommit. Must have the AWSCodeCommitReadOnly IAM policy.
Expand Down Expand Up @@ -109,6 +112,7 @@ To add CodeCommit repositories in Docker Container:
}
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/aws_codecommit.schema.json */}

### Mounting SSH keys into the container

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/azuredevops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ Azure DevOps connections support the following configuration options, which are

### admin/code_hosts/azuredevops.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/azuredevops.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// A flag to enforce Azure DevOps repository access permissions
Expand Down Expand Up @@ -124,6 +127,7 @@ Azure DevOps connections support the following configuration options, which are
"username": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/azuredevops.schema.json */}

## Webhooks

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/bitbucket_cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ Bitbucket Cloud connections support the following configuration options, which a

### admin/code_hosts/bitbucket_cloud.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_cloud.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// The workspace access token to use when authenticating with Bitbucket Cloud.
Expand Down Expand Up @@ -203,6 +206,7 @@ Bitbucket Cloud connections support the following configuration options, which a
"webhookSecret": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_cloud.schema.json */}

## Webhooks

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/bitbucket_server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,9 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi

### admin/code_hosts/bitbucket_server.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_server.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// If non-null, enforces Bitbucket Server / Bitbucket Data Center repository permissions.
Expand Down Expand Up @@ -327,3 +330,4 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi
"webhooks": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_server.schema.json */}
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/gerrit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ Gerrit connections support the following configuration options, which are specif

### admin/code_hosts/gerrit.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/gerrit.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// 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`.
Expand Down Expand Up @@ -150,3 +153,4 @@ Gerrit connections support the following configuration options, which are specif
"username": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/gerrit.schema.json */}
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,9 @@ GitHub connections support the following configuration options, which are specif

### admin/code_hosts/github.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/github.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// If non-null, enforces GitHub 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 "github" with the same `url` field as specified in this `GitHubConnection`.
Expand Down Expand Up @@ -580,3 +583,4 @@ If you would like to sync all public repositories while omitting archived repos,
]
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/github.schema.json */}
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits).

### admin/code_hosts/gitlab.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/gitlab.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// 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`.
Expand Down Expand Up @@ -333,6 +336,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config
// ...
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/gitlab.schema.json */}

## Access token scopes

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/gitolite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ To connect Gitolite to Sourcegraph:

### admin/code_hosts/gitolite.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/gitolite.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// A list of repositories to never mirror from this Gitolite instance. Supports excluding by exact name ({"name": "foo"}).
Expand Down Expand Up @@ -59,3 +62,4 @@ To connect Gitolite to Sourcegraph:
// - "gitolite.example.com/"
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/gitolite.schema.json */}
4 changes: 4 additions & 0 deletions docs/admin/code_hosts/other.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ Repositories must be listed individually:

### admin/code_hosts/other_external_service.schema.json

{/* SCHEMA_SYNC_START: admin/code_hosts/other_external_service.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// A list of repositories to never mirror by name after applying repositoryPathPattern. Supports excluding by exact name ({"name": "myrepo"}) or regular expression ({"pattern": ".*secret.*"}).
Expand Down Expand Up @@ -110,3 +113,4 @@ Repositories must be listed individually:
// - "git://host.xz:2333/"
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/other_external_service.schema.json */}
5 changes: 4 additions & 1 deletion docs/admin/code_hosts/phabricator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config

### admin/code_hosts/phabricator.schema.json


{/* SCHEMA_SYNC_START: admin/code_hosts/phabricator.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// The list of repositories available on Phabricator.
Expand All @@ -92,3 +94,4 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config
// - "https://phabricator.example.com"
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/phabricator.schema.json */}
4 changes: 4 additions & 0 deletions docs/admin/config/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Settings options and their default values are shown below.

### admin/config/settings.schema.json

{/* SCHEMA_SYNC_START: admin/config/settings.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// Disables observability-related site alert banners.
Expand Down Expand Up @@ -145,6 +148,7 @@ Settings options and their default values are shown below.
"experimentalFeatures": null
}
```
{/* SCHEMA_SYNC_END: admin/config/settings.schema.json */}

## Additional details on settings

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/config/site_config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ All site configuration options and their default values are shown below.

### admin/config/site.schema.json

{/* SCHEMA_SYNC_START: admin/config/site.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// Prompts user to install new browser for non es5
Expand Down Expand Up @@ -932,6 +935,7 @@ You can check the container logs to see if you have made any typos or mistakes i
],
}
```
{/* SCHEMA_SYNC_END: admin/config/site.schema.json */}

## Accessing global settings

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/repo/perforce.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,9 @@ With this setting, Sourcegraph will ignore any rules with a host other than `*`,

### `admin/code_hosts/perforce.schema.json`

{/* SCHEMA_SYNC_START: admin/code_hosts/perforce.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: Manual setup - will be automated via sourcegraph/sourcegraph releases */}
```json
{
// If non-null, enforces Perforce depot permissions.
Expand Down Expand Up @@ -332,6 +335,7 @@ Add `"batchChanges.enablePerforce": true` to `experimentalFeatures` in the [site
}
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/perforce.schema.json */}

Batch Changes does not support repos that use sub-repo permissions, so in order to use batch changes with Perforce depots, the code host cannot use [file-level permissions](#file-level-permissions).

Expand Down