sourcebot/schemas/v3/gitlab.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "GitlabConnectionConfig",
    "properties": {
        "type": {
            "const": "gitlab",
            "description": "GitLab Configuration"
        },
        "token": {
            "$ref": "./shared.json#/definitions/Token",
            "description": "An authentication token.",
            "examples": [
                {
                    "secret": "SECRET_KEY"
                }
            ]
        },
        "url": {
            "type": "string",
            "format": "url",
            "default": "https://gitlab.com",
            "description": "The URL of the GitLab host. Defaults to https://gitlab.com",
            "examples": [
                "https://gitlab.com",
                "https://gitlab.example.com"
            ],
            "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
        },
        "all": {
            "type": "boolean",
            "default": false,
            "description": "Sync all projects visible to the provided `token` (if any) in the GitLab instance. This option is ignored if `url` is either unset or set to https://gitlab.com ."
        },
        "users": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of users to sync with. All projects owned by the user and visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property."
        },
        "groups": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "examples": [
                [
                    "my-group"
                ],
                [
                    "my-group/sub-group-a",
                    "my-group/sub-group-b"
                ]
            ],
            "description": "List of groups to sync with. All projects in the group (and recursive subgroups) visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property. Subgroups can be specified by providing the path to the subgroup (e.g. `my-group/sub-group-a`)."
        },
        "projects": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "examples": [
                [
                    "my-group/my-project"
                ],
                [
                    "my-group/my-sub-group/my-project"
                ]
            ],
            "description": "List of individual projects to sync with. The project's namespace must be specified. See: https://docs.gitlab.com/ee/user/namespace/"
        },
        "topics": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "description": "List of project topics to include when syncing. Only projects that match at least one of the provided `topics` will be synced. If not specified, all projects will be synced, unless explicitly defined in the `exclude` property. Glob patterns are supported.",
            "examples": [
                [
                    "docs",
                    "core"
                ]
            ]
        },
        "exclude": {
            "type": "object",
            "properties": {
                "forks": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude forked projects from syncing."
                },
                "archived": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude archived projects from syncing."
                },
                "userOwnedProjects": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude user-owned projects from syncing."
                },
                "projects": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "default": [],
                    "examples": [
                        [
                            "my-group/my-project"
                        ]
                    ],
                    "description": "List of projects to exclude from syncing. Glob patterns are supported. The project's namespace must be specified, see: https://docs.gitlab.com/ee/user/namespace/"
                },
                "topics": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "List of project topics to exclude when syncing. Projects that match one of the provided `topics` will be excluded from syncing. Glob patterns are supported.",
                    "examples": [
                        [
                            "tests",
                            "ci"
                        ]
                    ]
                }
            },
            "additionalProperties": false
        },
        "revisions": {
            "$ref": "./shared.json#/definitions/GitRevisions"
        }
    },
    "required": [
        "type"
    ],
    "additionalProperties": false
}