sourcebot/schemas/v3/github.json at main · sourcebot-dev/sourcebot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "GithubConnectionConfig",
    "properties": {
        "type": {
            "const": "github",
            "description": "GitHub Configuration"
        },
        "token": {
            "$ref": "./shared.json#/definitions/Token",
            "description": "A Personal Access Token (PAT)."
        },
        "url": {
            "type": "string",
            "format": "url",
            "default": "https://github.com",
            "description": "The URL of the GitHub host. Defaults to https://github.com",
            "examples": [
                "https://github.com",
                "https://github.example.com"
            ],
            "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
        },
        "users": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[\\w.-]+$"
            },
            "default": [],
            "examples": [
                [
                    "torvalds",
                    "DHH"
                ]
            ],
            "description": "List of users to sync with. All repositories that the user owns will be synced, unless explicitly defined in the `exclude` property."
        },
        "orgs": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[\\w.-]+$"
            },
            "default": [],
            "examples": [
                [
                    "my-org-name"
                ],
                [
                    "sourcebot-dev",
                    "commaai"
                ]
            ],
            "description": "List of organizations to sync with. All repositories in the organization visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property."
        },
        "repos": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[\\w.-]+\\/[\\w.-]+$"
            },
            "default": [],
            "description": "List of individual repositories to sync with. Expected to be formatted as '{orgName}/{repoName}' or '{userName}/{repoName}'."
        },
        "topics": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "default": [],
            "description": "List of repository topics to include when syncing. Only repositories that match at least one of the provided `topics` will be synced. If not specified, all repositories 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 repositories from syncing."
                },
                "archived": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude archived repositories from syncing."
                },
                "repos": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "default": [],
                    "description": "List of individual repositories to exclude from syncing. Glob patterns are supported."
                },
                "topics": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "default": [],
                    "description": "List of repository topics to exclude when syncing. Repositories that match one of the provided `topics` will be excluded from syncing. Glob patterns are supported.",
                    "examples": [
                        [
                            "tests",
                            "ci"
                        ]
                    ]
                },
                "size": {
                    "type": "object",
                    "description": "Exclude repositories based on their disk usage. Note: the disk usage is calculated by GitHub and may not reflect the actual disk usage when cloned.",
                    "properties": {
                        "min": {
                            "type": "integer",
                            "description": "Minimum repository size (in bytes) to sync (inclusive). Repositories less than this size will be excluded from syncing."
                        },
                        "max": {
                            "type": "integer",
                            "description": "Maximum repository size (in bytes) to sync (inclusive). Repositories greater than this size will be excluded from syncing."
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "revisions": {
            "$ref": "./shared.json#/definitions/GitRevisions"
        },
        "enforcePermissions": {
            "type": "boolean",
            "description": "Controls whether repository permissions are enforced for this connection. When `PERMISSION_SYNC_ENABLED` is false, this setting has no effect. Defaults to the value of `PERMISSION_SYNC_ENABLED`. See https://docs.sourcebot.dev/docs/features/permission-syncing"
        },
        "enforcePermissionsForPublicRepos": {
            "type": "boolean",
            "default": false,
            "description": "Controls whether repository permissions are enforced for public repositories in this connection. When true, public repositories are only visible to users with a linked account for this connection's code host. When false, public repositories are visible to all users. Has no effect when enforcePermissions is false. Defaults to false. See https://docs.sourcebot.dev/docs/features/permission-syncing"
        }
    },
    "required": [
        "type"
    ],
    "additionalProperties": false
}