build-tools/evm-config.schema.json at main · electron/build-tools · 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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "format": "uri-reference"
    },
    "defaultTarget": {
      "type": "string",
      "description": "Default build target",
      "default": "electron"
    },
    "preserveSDK": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991,
      "description": "Preserve the N most recent Xcode SDK versions",
      "default": 5
    },
    "execName": {
      "type": "string",
      "minLength": 1,
      "description": "Name of the built executable to run",
      "default": "Electron"
    },
    "extends": {
      "type": "string",
      "minLength": 1,
      "description": "Name of base config to extend"
    },
    "remoteBuild": {
      "type": "string",
      "enum": [
        "reclient",
        "siso",
        "none"
      ],
      "description": "Whether to use remote builds and what system to use"
    },
    "rbeHelperPath": {
      "type": "string",
      "description": "Path to alternative reclient credential helper"
    },
    "rbeServiceAddress": {
      "type": "string",
      "description": "Alternative RBE cluster address"
    },
    "rbeInstance": {
      "type": "string",
      "description": "Alternative REv2 instance name. May be empty. siso only"
    },
    "rbeTlsClientCert": {
      "type": "string",
      "description": "Path to a TLS client certificate for RBE. Replaces the credential helper. siso only"
    },
    "rbeTlsClientKey": {
      "type": "string",
      "description": "Path to the private key for rbeTlsClientCert. siso only"
    },
    "rbePlatformProperties": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      },
      "description": "Remote platform properties, replacing the default backend config. siso only"
    },
    "rbeRemoteJobs": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991,
      "description": "Maximum number of build steps to run remotely at once. siso only",
      "default": 200
    },
    "root": {
      "type": "string",
      "minLength": 1,
      "description": "Path of the top directory. Home of the .gclient file"
    },
    "remotes": {
      "type": "object",
      "properties": {
        "electron": {
          "type": "object",
          "properties": {
            "origin": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "string",
                  "pattern": "^git@.+$"
                }
              ],
              "description": "Origin remote"
            },
            "fork": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "string",
                  "pattern": "^git@.+$"
                }
              ],
              "description": "Fork remote"
            }
          },
          "required": [
            "origin"
          ],
          "additionalProperties": false,
          "description": "Remotes for the Electron repo"
        }
      },
      "required": [
        "electron"
      ],
      "additionalProperties": false,
      "description": "Remotes for Git checkouts"
    },
    "gen": {
      "type": "object",
      "properties": {
        "args": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "description": "Extra arguments for GN"
        },
        "out": {
          "type": "string",
          "minLength": 1,
          "description": "Output directory"
        }
      },
      "required": [
        "args",
        "out"
      ],
      "additionalProperties": false,
      "description": "Configuration for GN"
    },
    "env": {
      "type": "object",
      "properties": {
        "CHROMIUM_BUILDTOOLS_PATH": {
          "type": "string",
          "minLength": 1,
          "description": "Path of Chromium buildtools in the checkout"
        },
        "GIT_CACHE_PATH": {
          "type": "string",
          "minLength": 1,
          "description": "Path to use as git cache for gclient"
        }
      },
      "additionalProperties": {
        "type": "string"
      },
      "description": "Environment variables set when building Electron"
    },
    "configValidationLevel": {
      "type": "string",
      "enum": [
        "strict",
        "warn",
        "none"
      ],
      "description": "Validation level for this configuration",
      "default": "strict"
    }
  },
  "additionalProperties": false,
  "title": "JSON schema for EVM configuration files",
  "oneOf": [
    {
      "required": [
        "extends"
      ]
    },
    {
      "properties": {
        "defaultTarget": {
          "type": "string",
          "pattern": "^chrome$"
        }
      },
      "required": [
        "defaultTarget",
        "env",
        "root"
      ]
    },
    {
      "required": [
        "root",
        "remotes",
        "gen",
        "env"
      ]
    }
  ]
}