Linking code from Bitbucket Data Center

Examples

{
    "type": "bitbucket",
    "deploymentType": "server",
    "url": "https://mybitbucketdeployment.com",
    // Include all repos in myProject...
    "projects": [
        "myProject"
    ],
    // ...except:
    "exclude": {
        // repos that are archived
        "archived": true,
        // repos that are forks
        "forks": true,
        // repos that match these glob patterns
        "repos": [
            "myProject/repo1",
            "myProject2/*"
        ]
    }
}

Authenticating with Bitbucket Data Center

In order to index private repositories, you’ll need to provide an access token to Sourcebot.

Create an access token for the desired scope (repo, project, or workspace). Visit the official Bitbucket Data Center docs for more info.

Next, provide the access token to Sourcebot:

Environment variables are only supported in a declarative config and cannot be used in the web UI.

Add the token property to your connection config:

{
    "type": "bitbucket",
    "token": {
        // note: this env var can be named anything. It
        // doesn't need to be `BITBUCKET_TOKEN`.
        "env": "BITBUCKET_TOKEN"
    }
    // .. rest of config ..
}

Pass this environment variable each time you run Sourcebot:

docker run \
    -e BITBUCKET_TOKEN=<PAT> \
    /* additional args */ \
    ghcr.io/sourcebot-dev/sourcebot:latest

Environment variables are only supported in a declarative config and cannot be used in the web UI.

Add the token property to your connection config:

{
    "type": "bitbucket",
    "token": {
        // note: this env var can be named anything. It
        // doesn't need to be `BITBUCKET_TOKEN`.
        "env": "BITBUCKET_TOKEN"
    }
    // .. rest of config ..
}

Pass this environment variable each time you run Sourcebot:

docker run \
    -e BITBUCKET_TOKEN=<PAT> \
    /* additional args */ \
    ghcr.io/sourcebot-dev/sourcebot:latest

Secrets are only supported when authentication is enabled.

Navigate to Secrets in settings and create a new secret with your PAT:

Add the token property to your connection config:

{
    "type": "bitbucket",
    "token": {
        "secret": "mysecret"
    }
    // .. rest of config ..
}

Schema reference

schemas/v3/bitbucket.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "BitbucketConnectionConfig",
    "properties": {
        "type": {
            "const": "bitbucket",
            "description": "Bitbucket configuration"
        },
        "user": {
            "type": "string",
            "description": "The username to use for authentication. Only needed if token is an app password."
        },
        "token": {
            "$ref": "./shared.json#/definitions/Token",
            "description": "An authentication token.",
            "examples": [
                {
                    "secret": "SECRET_KEY"
                }
            ]
        },
        "url": {
            "type": "string",
            "format": "url",
            "default": "https://api.bitbucket.org/2.0",
            "description": "Bitbucket URL",
            "examples": [
                "https://bitbucket.example.com"
            ],
            "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
        },
        "deploymentType": {
            "type": "string",
            "enum": ["cloud", "server"],
            "default": "cloud",
            "description": "The type of Bitbucket deployment"
        },
        "workspaces": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of workspaces to sync. Ignored if deploymentType is server."
        },
        "projects": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of projects to sync"
        },
        "repos": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of repos to sync"
        },
        "exclude": {
            "type": "object",
            "properties": {
                "archived": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude archived repositories from syncing."
                },
                "forks": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude forked repositories from syncing."
                },
                "repos": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "examples": [
                        [
                            "cloud_workspace/repo1", 
                            "server_project/repo2" 
                        ]
                    ],
                    "description": "List of specific repos to exclude from syncing."
                }
            },
            "additionalProperties": false
        },
        "revisions": {
            "$ref": "./shared.json#/definitions/GitRevisions"
        }
    },
    "required": [
        "type"
    ],
    "additionalProperties": false
}

General

Connecting your code

More

Linking code from Bitbucket Data Center

Examples

Authenticating with Bitbucket Data Center

Schema reference

General

Connecting your code

More

​Examples

​Authenticating with Bitbucket Data Center

​Schema reference

Examples

Authenticating with Bitbucket Data Center

Schema reference