Linking code from Bitbucket Cloud

Examples

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    // Include all repos in my-workspace...
    "workspaces": [
        "myWorkspace"
    ],
    // ...except:
    "exclude": {
        // repos that are archived
        "archived": true,
        // repos that are forks
        "forks": true,
        // repos that match these glob patterns
        "repos": [
            "myWorkspace/repo1",
            "myWorkspace2/*"
        ]
    }
}

Authenticating with Bitbucket Cloud

In order to index private repositories, you’ll need to provide authentication credentials. You can do this using an App Password or an Access Token

Navigate to the app password creation page and create an app password. Ensure that it has the proper permissions for the scope of info you want to fetch (i.e. workspace, project, and/or repo level)

Next, provide your username + app password pair to Sourcebot:

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

Add the token and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "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 and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "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 access token:

Add the token and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "token": {
        "secret": "mysecret"
    }
    // .. rest of config ..
}

Navigate to the app password creation page and create an app password. Ensure that it has the proper permissions for the scope of info you want to fetch (i.e. workspace, project, and/or repo level)

Next, provide your username + app password pair to Sourcebot:

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

Add the token and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "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 and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "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 access token:

Add the token and user (username associated with the app password you created) properties to your connection config:

{
    "type": "bitbucket",
    "deploymentType": "cloud",
    "user": "myusername",
    "token": {
        "secret": "mysecret"
    }
    // .. rest of config ..
}

Create an access token for the desired scope (repo, project, or workspace). Visit the official Bitbucket Cloud 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 Cloud

Examples

Authenticating with Bitbucket Cloud

Schema reference

General

Connecting your code

More

​Examples

​Authenticating with Bitbucket Cloud

​Schema reference

Examples

Authenticating with Bitbucket Cloud

Schema reference