This repository has been archived by the owner on Mar 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 92
/
pooldefinition.schema.json
147 lines (147 loc) · 6.46 KB
/
pooldefinition.schema.json
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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/dxatscale/sfpowerscripts/develop/packages/sfpowerscripts-cli/resources/schemas/pooldefinition.schema.json",
"title": "pool definition",
"description": "The definition for creating a pool of scratch orgs in sfpowerscripts",
"type": "object",
"required": ["tag", "maxAllocation"],
"additionalProperties": false,
"properties": {
"$schema": {
"description": "Support editors like vscode to help with IntelliSense",
"type": "string",
"default": "https://raw.githubusercontent.com/dxatscale/sfpowerscripts/develop/packages/sfpowerscripts-cli/resources/schemas/pooldefinition.schema.json"
},
"tag": {
"title": "Tag of the pool",
"description": "Tag or name to identify the scratch org pool",
"type": "string"
},
"waitTime": {
"title": "wait time",
"description": "Time to wait for scratch org creation in minutes (default:6 mins)",
"type": "integer",
"default": 6
},
"expiry": {
"title": "expiry",
"description": "Duration of the scratch org (in days) (default:2)",
"type": "integer",
"default": 2
},
"maxAllocation": {
"title": "Max number of scratch orgs to be allocated",
"description": "Maximum number of scratch orgs to be allocated in the pool",
"type": "integer"
},
"batchSize": {
"title": "Batch Size",
"description": "Control the parallelism of the pool creation (default:5)",
"type": "integer",
"default": 5
},
"configFilePath": {
"title": "Path to config file",
"description": "Reference an external .json file to specify the features and org preferences required for the metadata of your package, such as the scratch org definition.",
"type": "string",
"default": "config/project-scratch-def.json"
},
"releaseConfigFile": {
"title": "Path to release config file",
"description": "Path to the config file which determines how a release defintion should be generated, enable this for pools to use this release config to only utilize artifacts described the releae config",
"type": "string"
},
"succeedOnDeploymentErrors": {
"title": "Succeed on Deployment Errors",
"description": "In case of a deployment error, whether to keep that scratch org in the pool",
"type": "boolean",
"default": true
},
"installAll": {
"title": "Install all packages",
"description": "Install all package artifacts, in addition to the managed package dependencies",
"type": "boolean",
"default": false
},
"enableVlocity": {
"title": "Enable vlocity config deployment",
"description": "[alpha] Enable vlocity settings and config deployment. Please note it doesnt install vlocity managed package",
"type": "boolean",
"default": "false"
},
"enableSourceTracking": {
"title": "Enable source tracking",
"description": "Enable source tracking by deploying packages using source:push , and persisting local source tracking files",
"type": "boolean",
"default": true
},
"relaxAllIPRanges": {
"title": "Relax all IP Ranges",
"description": "Relax all IP addresses to enable developers to login to scratch orgs",
"type": "boolean",
"default": "false"
},
"ipRangesToBeRelaxed": {
"title": "IP ranges to be relaxed",
"description": "Relax IP address of developers to allow access to scratch orgs",
"type": "array"
},
"retryOnFailure": {
"title": "Retry on failure",
"description": "Retry installation of packages on failed deployment",
"type": "boolean",
"default": "false"
},
"maxRetryCount": {
"title": "Max Retry Count",
"description": "Maximum number of attempts sfpowerscripts should retry installation of packages on failed deployment",
"type": "number",
"default": "2"
},
"snapshotPool": {
"title": "Snapshot Pool",
"description": "Use a pre-prepared pool to further add packages on top of it",
"type": "string"
},
"postDeploymentScriptPath": {
"title": "Post Script",
"description": "Execute a custom script after all the artifacts are deployed into a particular org",
"type": "string"
},
"preDependencyInstallationScriptPath": {
"title": "Pre Script",
"description": "Execute a custom script before denpendencies install into a particular org",
"type": "string"
},
"disableSourcePackageOverride": {
"title": "Disable installation of unlocked packages as source package",
"description": "Prepare by default utilizes source package for installing unlocked packages to the scratchorg, disabling this flag will allow to install it ",
"type": "boolean",
"default":false
},
"fetchArtifacts": {
"title": "Fetch Artifacts using below mechanism",
"description": "Fetch artifacts from artifact registry using below mechanism",
"type": "object",
"oneOf": [{ "required": ["artifactFetchScript"] }, { "required": ["npm"] }],
"properties": {
"artifactFetchScript": {
"title": "Path to the script for fetching artifacts",
"description": "Path to Shell script that handles fetching artifacts from a registry",
"type": "string"
},
"npm": {
"type": "object",
"required": ["scope"],
"properties": {
"scope": {
"title": "Scope of NPM packages",
"description": "Scope of NPM packages",
"type": "string"
}
}
}
}
}
}
}