Skip to content

Update JSON schemas for v6.5.1211 #1235

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.

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 28 additions & 9 deletions docs/admin/code_hosts/aws_codecommit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ AWS CodeCommit connections support the following configuration options, which ar

{/* 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 */}
{/* Last updated: 2025-07-01T23:25:36Z via sourcegraph/sourcegraph@v6.5.1211 */}
```json
{
// REQUIRED:
// The AWS access key ID to use when listing and updating repositories from AWS CodeCommit. Must have the AWSCodeCommitReadOnly IAM policy.
"accessKeyID": null,

// A list of repositories to never mirror from AWS CodeCommit.
//
// Supports excluding by name ({"name": "git-codecommit.us-west-1.amazonaws.com/repo-name"}) or by ARN ({"id": "arn:aws:codecommit:us-west-1:999999999999:name"}).
"exclude": null,
// Other example values:
// - [
// {
Expand All @@ -61,35 +60,55 @@ AWS CodeCommit connections support the following configuration options, which ar
// "name": "go-client"
// }
// ]
"exclude": null,

// REQUIRED:
// The Git credentials used for authentication when cloning an AWS CodeCommit repository over HTTPS.
//
// See the AWS CodeCommit documentation on Git credentials for CodeCommit: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#git-credentials-code-commit.
// For detailed instructions on how to create the credentials in IAM, see this page: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html
"gitCredentials": null,
"gitCredentials": {
"password": null,
"username": null
},

// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
"gitSSHCipher": null,

// SSH keys to use when cloning Git repo.
"gitSSHCredential": null,

// The ID of the SSH key created for your IAM users. It is required when using SSH to clone repositories.
"gitSSHKeyID": null,

// The type of Git URLs to use for cloning and fetching Git repositories.
// Valid options: "http", "ssh"
"gitURLType": "http",

// Deprecated and ignored field which will be removed entirely in the next release. AWS CodeCommit repositories can no longer be enabled or disabled explicitly. Configure which repositories should not be mirrored via "exclude" instead.
"initialRepositoryEnablement": false,

// The maximum number of repos that will be deleted per sync. A value of 0 or less indicates no maximum.
"maxDeletions": 0,

// REQUIRED:
// The AWS region in which to access AWS CodeCommit. See the list of supported regions at https://docs.aws.amazon.com/codecommit/latest/userguide/regions.html#regions-git.
// Valid options: "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2"
"region": "us-east-1",

// The pattern used to generate a the corresponding Sourcegraph repository name for an AWS CodeCommit repository. In the pattern, the variable "{name}" is replaced with the repository's name.
//
// For example, if your Sourcegraph instance is at https://src.example.com, then a repositoryPathPattern of "awsrepos/{name}" would mean that a AWS CodeCommit repository named "myrepo" is available on Sourcegraph at https://src.example.com/awsrepos/myrepo.
//
// 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.
"repositoryPathPattern": "{name}",
// Other example values:
// - "git-codecommit.us-west-1.amazonaws.com/{name}"
// - "git-codecommit.eu-central-1.amazonaws.com/{name}"
"repositoryPathPattern": "{name}",

// REQUIRED:
// The AWS secret access key (that corresponds to the AWS access key ID set in `accessKeyID`).
"secretAccessKey": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/aws_codecommit.schema.json */}

## Setup steps for SSH connections to AWS CodeCommit repositories

To add CodeCommit repositories in Docker Container:
Expand Down
59 changes: 47 additions & 12 deletions docs/admin/code_hosts/azuredevops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,15 @@ Azure DevOps connections support the following configuration options, which are

{/* 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 */}
{/* Last updated: 2025-07-01T23:25:35Z via sourcegraph/sourcegraph@v6.5.1211 */}
```json
// Authentication alternatives: token OR windowsPassword

{
// A flag to enforce Azure DevOps repository access permissions
"enforcePermissions": false,

// A list of repositories to never mirror from Azure DevOps Services.
"exclude": null,
// Other example values:
// - [
// {
Expand All @@ -92,43 +93,77 @@ Azure DevOps connections support the following configuration options, which are
// "pattern": "^topsecretproject/.*"
// }
// ]
"exclude": null,

// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
"gitSSHCipher": null,

// SSH keys to use when cloning Git repo.
"gitSSHCredential": null,

// The type of Git URLs to use for cloning and fetching Git repositories.
//
// If "http", Sourcegraph will access repositories using Git URLs of the form http(s)://dev.azure.com/myrepo.git.
//
// If "ssh", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. 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.
// If "ssh", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.
// Valid options: "http", "ssh"
"gitURLType": "http",

// The maximum number of repos that will be deleted per sync. A value of 0 or less indicates no maximum.
"maxDeletions": 0,

// An array of organization names identifying Azure DevOps organizations whose repositories should be mirrored on Sourcegraph.
"orgs": null,
// Other example values:
// - ["name"]
// - [
// "name"
// ]
// - [
// "kubernetes",
// "golang",
// "facebook"
// ]
"orgs": null,

// An array of projects "org/project" strings specifying which Azure DevOps projects' repositories should be mirrored on Sourcegraph.
// Other example values:
// - [
// "org/project"
// ]
"projects": null,

// Rate limit applied when making background API requests.
"rateLimit": {
"enabled": false,
"requestsPerHour": 0
},

// The pattern used to generate the corresponding Sourcegraph repository name for a Azure DevOps repository.
// - "{host}" is replaced with the Azure DevOps URL's host (such as dev.azure.com)
// - "{orgName}" is replaced with the repository's parent projects owning organization (or collection on DevOps server)
// - "{projectName}" is replaced with the repository's parent project
// - "{repositoryName}" is replaced with the repository's name.
// For example, if your Azure DevOps is https://dev.azure.com and your Sourcegraph is https://src.example.com, then a repositoryPathPattern of "{host}/{orgName}/{projectName}/{repositoryName}" would mean that a Azure DevOps repository at https://dev.azure.com/MYORG/MYPROJECT/MYREPO is available on Sourcegraph at https://src.example.com/dev.azure.com/MYORG/MYPROJECT/MYREPO.
// 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.
// Other example values:
// - ["org/project"]
// - "{projectName}/{repositoryName}"
"repositoryPathPattern": "{host}/{orgName}/{projectName}/{repositoryName}",

// The Personal Access Token associated with the Azure DevOps username used for authentication.
"token": null,

// REQUIRED:
// URL for Azure DevOps Services, set to https://dev.azure.com.
"url": null,
// Other example values:
// - "https://dev.azure.com"
"url": null,

// A username for authentication with the Azure DevOps code host.
"username": null
// REQUIRED:
// A username for authentication with the Azure DevOps code host. Typically an email address when connect to Azure DevOps Services (cloud) and a domain\username when connecting to Azure DevOp Server (onPrem)
"username": null,

// Windows account password (Azure Devops Server OnPrem Only): This is needed to clone the repo, the Token will be used for REST API calls
"windowsPassword": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/azuredevops.schema.json */}

## Configuration Notes

### Token Requirements
Expand Down
51 changes: 35 additions & 16 deletions docs/admin/code_hosts/bitbucket_cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,27 +118,29 @@ Bitbucket Cloud connections support the following configuration options, which a

{/* 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 */}
{/* Last updated: 2025-07-01T23:25:34Z via sourcegraph/sourcegraph@v6.5.1211 */}
```json
// Authentication alternatives: username + appPassword

{
// The workspace access token to use when authenticating with Bitbucket Cloud.
"accessToken": null,

// The API URL of Bitbucket Cloud, such as https://api.bitbucket.org. Generally, admin should not modify the value of this option because Bitbucket Cloud is a public hosting platform.
"apiURL": null,
// Other example values:
// - "https://api.bitbucket.org"
"apiURL": null,

// The app password to use when authenticating to the Bitbucket Cloud. Also set the corresponding "username" field.
"appPassword": null,

// If non-null, enforces Bitbucket Cloud 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 "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`.
"authorization": null,
"authorization": {
"identityProvider": null
},

// A list of repositories to never mirror from Bitbucket Cloud. Takes precedence over "teams" configuration.
//
// Supports excluding by name ({"name": "myorg/myrepo"}) or by UUID ({"uuid": "{fceb73c7-cef6-4abe-956d-e471281126bd}"}).
"exclude": null,
// Other example values:
// - [
// {
Expand All @@ -159,55 +161,72 @@ Bitbucket Cloud connections support the following configuration options, which a
// "pattern": "^topsecretproject/.*"
// }
// ]
"exclude": null,

// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
"gitSSHCipher": null,

// SSH keys to use when cloning Git repo.
"gitSSHCredential": null,

// The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Cloud.
//
// If "http", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form https://bitbucket.org/myteam/myproject.git.
//
// If "ssh", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form git@bitbucket.org: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.
"gitURLType": "http",
// Valid options: "http", "ssh"
// Other example values:
// - "ssh"
"gitURLType": "http",

// The maximum number of repos that will be deleted per sync. A value of 0 or less indicates no maximum.
"maxDeletions": 0,

// Rate limit applied when making background API requests to Bitbucket Cloud.
"rateLimit": {
"enabled": true,
"requestsPerHour": 7200
},

// An array of repository "projectKey/repositorySlug" strings specifying repositories to mirror on Sourcegraph.
// Other example values:
// - [
// "myproject/myrepo",
// "myproject/myotherrepo"
// ]
"repos": null,

// The pattern used to generate the corresponding Sourcegraph repository name for a Bitbucket Cloud repository.
//
// - "{host}" is replaced with the Bitbucket Cloud URL's host (such as bitbucket.org), and "{nameWithOwner}" is replaced with the Bitbucket Cloud repository's "owner/path" (such as "myorg/myrepo").
//
// - "{host}" is replaced with the Bitbucket Cloud URL's host (such as bitbucket.org), and "{nameWithOwner}" is replaced with the Bitbucket Cloud repository's "owner/path" (such as "myorg/myrepo").
// For example, if your Bitbucket Cloud is https://bitbucket.org and your Sourcegraph is https://src.example.com, then a repositoryPathPattern of "{host}/{nameWithOwner}" would mean that a Bitbucket Cloud repository at https://bitbucket.org/alice/my-repo is available on Sourcegraph at https://src.example.com/bitbucket.org/alice/my-repo.
//
// 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.
"repositoryPathPattern": "{host}/{nameWithOwner}",

// An array of team names identifying Bitbucket Cloud teams whose repositories should be mirrored on Sourcegraph.
"teams": null,
// Other example values:
// - ["name"]
// - [
// "name"
// ]
// - [
// "kubernetes",
// "golang",
// "facebook"
// ]
"teams": null,

// REQUIRED:
// URL of Bitbucket Cloud, such as https://bitbucket.org. Generally, admin should not modify the value of this option because Bitbucket Cloud is a public hosting platform.
"url": null,
// Other example values:
// - "https://bitbucket.org"
"url": null,

// The username to use when authenticating to the Bitbucket Cloud. Also set the corresponding "appPassword" field.
"username": null,

// ⚠️ DEPRECATED: Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice
// A shared secret used to authenticate incoming webhooks (minimum 12 characters).
"webhookSecret": null
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_cloud.schema.json */}

## Configuration Notes

Bitbucket Cloud connections provide streamlined configuration for cloud-hosted repositories:
Expand Down
Loading