-
Notifications
You must be signed in to change notification settings - Fork 7
/
schema.json
559 lines (559 loc) · 18.6 KB
/
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
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "https://github.com/gembaadvantage/uplift/internal/config/uplift",
"title": "Uplift",
"description": "A JSON schema for the Uplift configuration file",
"definitions": {
"Bump": {
"properties": {
"file": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "The path of the file relative to where Uplift is executed. Glob patterns can be used to match multiple files at the same time. Glob syntax is based on https://github.com/goreleaser/fileglob",
"type": "string",
"minLength": 1
},
"regex": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A regex matcher to be used when bumping the file. Multiple regex matches are supported. Each will be carried out in the order they are defined here. All matches must succeed for the file to be bumped",
"items": {
"$ref": "#/definitions/RegexBump"
},
"type": "array",
"minItems": 1
},
"json": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A JSON path matcher to be used when bumping the file. Multiple path matches are supported. Each will be carried out in the order they are defined here. All matches must succeed for the file to be bumped. JSON path syntax is based on https://github.com/tidwall/sjson",
"items": {
"$ref": "#/definitions/JSONBump"
},
"type": "array",
"minItems": 1
}
},
"type": "object",
"additionalProperties": false,
"required": [
"file"
],
"not": {
"properties": {
"regex": {
"maxItems": 0
},
"json": {
"maxItems": 0
}
}
}
},
"RegexBump": {
"properties": {
"pattern": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A regex pattern for matching and replacing the version within the file.",
"type": "string",
"minLength": 1
},
"count": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "The number of times any matched version should be replaced",
"type": "integer",
"minimum": 0
},
"semver": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A flag controlling if the matched version in the file should be replaced with a semantic version. This will strip any 'v' prefix if needed",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"pattern"
]
},
"JSONBump": {
"properties": {
"path": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A JSON path for matching and replacing the version within the file",
"type": "string",
"minLength": 1
},
"semver": {
"$comment": "https://upliftci.dev/reference/config#bumps",
"description": "A flag controlling if the matched version in the file should be replaced with a semantic version. This will strip any 'v' prefix if needed",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"path"
]
},
"CommitAuthor": {
"properties": {
"name": {
"$comment": "https://upliftci.dev/reference/config#commitAuthor",
"description": "Name of the commit author",
"type": "string",
"minLength": 1
},
"email": {
"$comment": "https://upliftci.dev/reference/config#commitAuthor",
"description": "Email of the commit author",
"type": "string",
"minLength": 1
}
},
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"email"
]
}
]
},
"Changelog": {
"properties": {
"sort": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "Change the sort order of the commits within each changelog entry. Supported values are [asc, desc, ASC or DESC]. Defaults to desc (descending order) to mirror the default behaviour of 'git log'",
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC"
]
},
"exclude": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "A list of commits to exclude during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be excluded. Auto-generated commits from Uplift (with the prefix ci(uplift)) will always be excluded",
"items": {
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"include": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "A list of commits to cherry-pick and include during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be included",
"items": {
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"multiline": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "Include multiline commit messages within the changelog. Disables default behaviour of truncating a commit message to its first line",
"type": "boolean"
},
"trimHeader": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "Trims any lines preceding the conventional commit type in the commit message",
"type": "boolean"
},
"skipPrerelease": {
"$comment": "https://upliftci.dev/reference/config#changelog",
"description": "Skips generating a changelog for any prerelease. All commits from a prerelease will be appended to the changelog entry for the next release",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": [
"sort"
]
},
{
"required": [
"exclude"
]
},
{
"required": [
"include"
]
},
{
"required": [
"multiline"
]
},
{
"required": [
"trimHeader"
]
},
{
"required": [
"skipPrerelease"
]
}
]
},
"Git": {
"properties": {
"ignoreDetached": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "A flag for suppressing the git detached HEAD repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false",
"type": "boolean"
},
"ignoreShallow": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "A flag for suppressing the git shallow repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false",
"type": "boolean"
},
"pushOptions": {
"items": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "An array of Git push options that can be independently configured for both branch and tag operations within Uplift. Provided options will be filtered accordingly and appended to the git push operation through the use of the --push-option flag as documented in https://git-scm.com/docs/git-push#Documentation/git-push.txt",
"$ref": "#/definitions/GitPushOptions"
},
"type": "array",
"minItems": 1
},
"includeArtifacts": {
"items": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "Defines a list of files that uplift will ignore when checking the status of the current repository. If a change is detected that is not defined in this list, uplift will assume its default behaviour and fail due to the repository being in a dirty state"
},
"type": "array",
"minItems": 1
}
},
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": [
"ignoreDetached"
]
},
{
"required": [
"ignoreShallow"
]
},
{
"required": [
"pushOptions"
]
}
]
},
"GitPushOptions": {
"anyOf": [
{
"description": "A push option that will be appended to a git push operation within Uplift",
"type": "string",
"minLength": 1
},
{
"properties": {
"option": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "A push option that will be appended to a git push operation within Uplift",
"type": "string",
"minLength": 1
},
"skipBranch": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "A flag to control the exclusion of the current push option from any branch based git push operation",
"type": "boolean"
},
"skipTag": {
"$comment": "https://upliftci.dev/reference/config#git",
"description": "A flag to control the exclusion of the current push option from any tag based git push operation",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"option"
]
}
]
},
"Gitea": {
"properties": {
"url": {
"$comment": "https://upliftci.dev/reference/config#gitea",
"description": "The URL of the self-hosted instance of Gitea. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository",
"type": "string",
"minLength": 1
}
},
"type": "object",
"additionalProperties": false,
"required": [
"url"
]
},
"GitHub": {
"properties": {
"url": {
"$comment": "https://upliftci.dev/reference/config#github",
"description": "The URL of the enterprise instance of GitHub. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository",
"type": "string",
"minLength": 1
}
},
"type": "object",
"additionalProperties": false,
"required": [
"url"
]
},
"GitLab": {
"properties": {
"url": {
"$comment": "https://upliftci.dev/reference/config#gitlab",
"description": "The URL of the self-managed instance of GitLab. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository",
"type": "string",
"minLength": 1
}
},
"type": "object",
"additionalProperties": false,
"required": [
"url"
]
},
"Hooks": {
"properties": {
"before": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute before Uplift runs tasks within any workflow",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"beforeBump": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute before Uplift bumps any configured file",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"beforeTag": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute before Uplift tags the repository with the next semantic release",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"beforeChangelog": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute before Uplift runs its changelog generation task",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"after": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute after Uplift completes all tasks within any workflow",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"afterBump": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute after Uplift bumps all configured files",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"afterTag": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute after Uplift tags the repository with the next semantic release",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"afterChangelog": {
"items": {
"$comment": "https://upliftci.dev/reference/config#hooks",
"description": "A list of shell commands or scripts to execute after Uplift generates or updates a changelog",
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
}
},
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": [
"before"
]
},
{
"required": [
"beforeBump"
]
},
{
"required": [
"beforeTag"
]
},
{
"required": [
"beforeChangelog"
]
},
{
"required": [
"after"
]
},
{
"required": [
"afterBump"
]
},
{
"required": [
"afterTag"
]
},
{
"required": [
"afterChangelog"
]
}
]
}
},
"properties": {
"annotatedTags": {
"$comment": "https://upliftci.dev/reference/config#annotatedTags",
"description": "Use annotated tags instead of lightweight tags when tagging a new semantic version. An annotated tag is treated like a regular commit by git and contains both author details and a commit message. Uplift will either use its defaults or the custom commit details provided when generating the annotated tag.",
"type": "boolean"
},
"bumps": {
"items": {
"$ref": "#/definitions/Bump"
},
"type": "array",
"minItems": 1,
"description": "Define a series of files whose semantic version will be bumped. Supports both Regex and JSON Path based file bumps"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor",
"description": "Changes the commit author used by Uplift when committing any staged changes.\nDefaults to the Uplift Bot: uplift-bot <uplift@gembaadvantage.com>"
},
"commitMessage": {
"$comment": "https://upliftci.dev/reference/config#commitMessage",
"description": "Change the default commit message used by Uplift when committing any staged changes.\nThe default commit message is: ci(uplift): uplifted for version v0.1.0",
"type": "string",
"minLength": 1
},
"changelog": {
"$ref": "#/definitions/Changelog",
"description": "Customise how Uplift creates and updates a changelog within the repository"
},
"git": {
"$ref": "#/definitions/Git",
"description": "Customise how Uplift interacts with Git"
},
"gitea": {
"$ref": "#/definitions/Gitea",
"description": "Configure SCM detection and support for Gitea"
},
"github": {
"$ref": "#/definitions/GitHub",
"description": "Configure SCM detection and support for GitHub"
},
"gitlab": {
"$ref": "#/definitions/GitLab",
"description": "Configure SCM detection and support for GitLab"
},
"hooks": {
"$ref": "#/definitions/Hooks",
"description": "Extend Uplift through the use of hooks. A hook is a specific point during a workflow where Uplift executes adhoc shell commands and scripts"
},
"env": {
"$comment": "https://upliftci.dev/reference/config#env",
"description": "Define a set of environment variables that are made available to all hooks. Supports loading environment variables from DotEnv (.env) files. Environment variables are merged with system wide ones.",
"items": {
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
}
},
"type": "object",
"additionalProperties": false,
"allOf": [
{
"oneOf": [
{
"required": [
"gitea"
]
},
{
"required": [
"github"
]
},
{
"required": [
"gitlab"
]
}
]
},
{
"not": {
"required": [
"gitea",
"github",
"gitlab"
]
}
}
]
}