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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
|
{
"$id": "https://bitbucket.org/product/features/pipelines",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Custom JSON schema for bitbucket-pipelines.yml",
"properties": {
"clone": { "$ref": "#/components/schemas/clone" },
"definitions": {
"description": "The definitions of caches and services used in the declared pipelines.",
"properties": {
"caches": {
"additionalProperties": {
"$ref": "#/components/schemas/cache"
},
"title": "Custom cache definitions",
"type": "object"
},
"imports": {
"pipelines": {
"additionalProperties": {
"$ref": "#/components/schemas/import_source"
},
"description": "Definitions of the pipelines imports that can be used in this file.",
"title": "Import source definitions",
"type": "object"
}
},
"pipelines": {
"additionalProperties": {
"$ref": "#/components/schemas/custom_pipeline"
},
"description": "Definitions of the pipelines which can be used in other repositories of the same Bitbucket workspace.",
"title": "Shared pipeline definitions",
"type": "object"
},
"services": {
"additionalProperties": {
"$ref": "#/components/schemas/service"
},
"title": "Service definitions",
"type": "object"
}
},
"title": "Global Definitions",
"type": "object"
},
"export": {
"default": false,
"description": "Allows other Bitbucket repositories to import pipeline definitions from this file. A shared pipeline definition can't contain another `import` property.",
"title": "Enables shared pipelines definitions.",
"type": "boolean"
},
"image": { "$ref": "#/components/schemas/image" },
"labels": {
"description": "Additional key value data supplied in the configuration YAML.",
"example": { "buildTool": "maven", "jvm": "jdk17" },
"title": "Pipeline Labels",
"type": "object"
},
"options": {
"description": "Global options allow to override the default values applied to all steps in all declared pipelines.",
"properties": {
"docker": {
"default": false,
"description": "Enables Docker service for every step.",
"type": "boolean"
},
"max-time": {
"$ref": "#/components/schemas/max_time"
},
"runs-on": {
"$ref": "#/components/schemas/runs_on"
},
"runtime": {
"$ref": "#/components/schemas/runtime"
},
"size": { "$ref": "#/components/schemas/size" }
},
"title": "Global Options",
"type": "object"
},
"pipelines": {
"properties": {
"branches": {
"additionalProperties": {
"$ref": "#/components/schemas/pipeline"
},
"description": "Branch-specific build pipelines.",
"title": "Branch Pipelines",
"type": "object"
},
"custom": {
"additionalProperties": {
"$ref": "#/components/schemas/custom_pipeline"
},
"description": "Pipelines that can only be triggered manually or be scheduled.",
"title": "Custom Pipelines",
"type": "object"
},
"default": {
"$ref": "#/components/schemas/pipeline",
"description": "Default pipeline runs on every push except for tags unless a branch-specific pipeline is defined.",
"title": "Default Pipeline"
},
"pull-requests": {
"additionalProperties": {
"$ref": "#/components/schemas/pull_requests_pipeline"
},
"description": "Pull-request-specific build pipelines.",
"title": "Pull Request Pipelines",
"type": "object"
},
"tags": {
"additionalProperties": {
"$ref": "#/components/schemas/pipeline"
},
"description": "Tag-specific build pipelines.",
"title": "Tag Pipelines",
"type": "object"
}
},
"title": "Pipelines",
"type": "object"
},
"triggers": {
"additionalProperties": {
"$ref": "#/components/schemas/trigger_configuration_list"
},
"description": "Event-based triggers that automatically run pipelines when specific events occur. The property names represent trigger types (e.g., repository-push, pullrequest-push, pipeline-completed, deployment-completed, pullrequest-created).",
"example": {
"deployment-completed": [
{
"condition": "BITBUCKET_TRIGGER_DEPLOYMENT_STATUS == \"FAILED\"",
"pipelines": ["pipeline2"]
}
],
"pipeline-completed": [
{
"condition": "BITBUCKET_TRIGGER_PIPELINE_STATUS == \"FAILED\"",
"pipelines": ["pipeline1"]
}
],
"pullrequest-created": [
{
"condition": "glob(BITBUCKET_BRANCH, \"feature/*\")",
"pipelines": ["pipeline1"]
}
],
"pullrequest-fulfilled": [
{
"condition": "glob(BITBUCKET_BRANCH, \"feature/*\")",
"pipelines": ["pipeline2"]
}
],
"pullrequest-push": [
{
"condition": "BITBUCKET_PR_DESTINATION_BRANCH == \"main\"",
"pipelines": ["pipeline2"]
}
],
"pullrequest-rejected": [
{
"condition": "glob(BITBUCKET_BRANCH, \"feature/*\")",
"pipelines": ["pipeline1"]
}
],
"pullrequest-reviewer-status-updated": [
{
"condition": "glob(BITBUCKET_BRANCH, \"feature/*\")",
"pipelines": ["pipeline1"]
}
],
"pullrequest-updated": [
{
"condition": "glob(BITBUCKET_BRANCH, \"feature/*\")",
"pipelines": ["pipeline2"]
}
],
"repository-push": [
{
"condition": "BITBUCKET_BRANCH == \"main\"",
"pipelines": ["pipeline1"]
}
]
},
"title": "Pipeline Triggers",
"type": "object"
}
},
"type": "object",
"components": {
"schemas": {
"artifacts": {
"oneOf": [
{ "$ref": "#/components/schemas/artifacts_paths" },
{ "$ref": "#/components/schemas/artifacts_expanded" }
]
},
"artifacts_expanded": {
"properties": {
"download": {
"oneOf": [
{
"default": true,
"description": "Enables downloading of all available artifacts at the end of a step.",
"type": "boolean"
},
{
"description": "Define the list of filtered artifacts to be downloaded by the step.",
"items": { "type": "string" },
"minItems": 1,
"type": "array"
}
]
},
"paths": { "$ref": "#/components/schemas/artifacts_paths" },
"upload": {
"items": {
"$ref": "#/components/schemas/artifacts_upload"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"artifacts_paths": {
"items": {
"description": "Glob pattern for the path to the artifacts.",
"title": "Artifact Path Pattern",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"artifacts_upload": {
"description": "The artifact to be uploaded.",
"properties": {
"capture-on": {
"description": "The capture on field for the artifact.",
"enum": ["success", "failed", "always"],
"title": "Artifact Capture On",
"type": "string"
},
"depth": {
"description": "The depth to search for the artifact files.",
"minimum": 1,
"title": "Artifact Depth",
"type": "integer"
},
"ignore-paths": {
"description": "The ignore paths for the artifact.",
"items": {
"description": "Glob pattern for paths to ignore when capturing artifacts.",
"title": "Ignore Path Pattern",
"type": "string"
},
"title": "Artifact Ignore Paths",
"type": "array"
},
"name": {
"description": "The name of the artifact.",
"title": "Artifact Name",
"type": "string"
},
"paths": { "$ref": "#/components/schemas/artifacts_paths" },
"type": {
"default": "shared",
"description": "The type of the artifact.",
"enum": ["shared", "scoped", "test-reports"],
"title": "Artifact Type",
"type": "string"
}
},
"required": ["name", "paths"],
"title": "Artifact Upload object",
"type": "object"
},
"cache": {
"oneOf": [
{ "$ref": "#/components/schemas/cache_path" },
{ "$ref": "#/components/schemas/cache_expanded" }
]
},
"cache_expanded": {
"properties": {
"key": {
"properties": {
"files": {
"description": "Checksum of these file paths will be used to generate the cache key.",
"items": {
"description": "Path to a file or glob pattern of files in the repository which form the cache key.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": ["files"],
"title": "Cache Key",
"type": "object"
},
"path": { "$ref": "#/components/schemas/cache_path" }
},
"required": ["path"],
"title": "Cache",
"type": "object"
},
"cache_path": {
"description": "Path to the directory to be cached, can be absolute or relative to the clone directory.",
"title": "Cache Path",
"type": "string"
},
"clone": {
"description": "Settings for cloning a repository into a container.",
"properties": {
"depth": {
"default": 50,
"description": "The depth argument of Git clone operation. It can be either number or \"full\" value",
"example": "full",
"oneOf": [
{ "minimum": 1, "type": "integer" },
{ "enum": ["full"], "type": "string" }
],
"title": "Git Clone Depth"
},
"enabled": {
"default": true,
"description": "Enables cloning of the repository.",
"type": "boolean"
},
"lfs": {
"default": false,
"description": "Enables the download of files from LFS storage when cloning.",
"type": "boolean"
},
"skip-ssl-verify": {
"default": false,
"description": "Disables SSL verification during Git clone operation, allowing the use of self-signed certificates.",
"type": "boolean"
}
},
"title": "Clone Repository Settings",
"type": "object"
},
"cloud": {
"description": "Custom cloud step runtime",
"properties": {
"arch": {
"default": "x86",
"description": "Architecture type used to run the step.",
"enum": ["x86", "arm"],
"type": "string"
},
"atlassian-ip-ranges": {
"default": false,
"description": "Whether it uses Atlassian ip ranges.",
"type": "boolean"
},
"instance-type": {
"description": "Instance type for the cloud runtime.",
"type": "string"
},
"version": {
"description": "Cloud Runtime version.",
"type": "string"
}
},
"title": "Cloud step runtime",
"type": "object"
},
"condition": {
"properties": {
"changesets": {
"additionalProperties": false,
"description": "Condition on the changesets involved in the pipeline.",
"maxProperties": 1,
"properties": {
"excludePaths": {
"description": "Condition which holds only if all of the modified files match any of the specified patterns.",
"items": {
"description": "Glob pattern to match the file path.",
"title": "File Path Pattern",
"type": "string"
},
"minItems": 1,
"title": "Exclude Paths",
"type": "array"
},
"includePaths": {
"description": "Condition which holds only if any of the modified files match any of the specified patterns.",
"items": {
"description": "Glob pattern to match the file path.",
"title": "File Path Pattern",
"type": "string"
},
"minItems": 1,
"title": "Include Paths",
"type": "array"
}
},
"title": "Changeset Condition",
"type": "object"
}
},
"required": ["changesets"],
"type": "object"
},
"custom_pipeline": {
"oneOf": [
{ "$ref": "#/components/schemas/items_with_variables" },
{ "$ref": "#/components/schemas/import_pipeline" }
]
},
"fail_fast": {
"default": false,
"title": "Fail Fast",
"type": "boolean"
},
"final_item": {
"additionalProperties": false,
"properties": {
"final": { "$ref": "#/components/schemas/final_step" }
},
"type": "object"
},
"final_step": {
"allOf": [
{ "$ref": "#/components/schemas/step_base" },
{
"description": "A special step that always runs at the end of a pipeline, even if earlier steps fail or the pipeline is stopped. Only one final step is allowed per pipeline and it must be the last item.",
"properties": {
"deployment": { "not": {} },
"fail-fast": { "not": {} },
"trigger": {
"description": "The final step always runs automatically. Manual trigger is not supported.",
"enum": ["automatic"],
"type": "string"
}
},
"title": "Final Pipeline Step",
"type": "object"
}
]
},
"image": {
"oneOf": [
{ "$ref": "#/components/schemas/image_no_auth" },
{ "$ref": "#/components/schemas/image_basic_auth" },
{ "$ref": "#/components/schemas/image_aws_auth" },
{ "$ref": "#/components/schemas/image_name" }
]
},
"image_aws_auth": {
"allOf": [
{ "$ref": "#/components/schemas/image_base" },
{
"properties": {
"aws": {
"oneOf": [
{
"properties": {
"access-key": {
"description": "The access key for Amazon Elastic Container Registry (AWS ECR).",
"title": "AWS Access Key",
"type": "string"
},
"secret-key": {
"description": "The secret key for Amazon Elastic Container Registry (AWS ECR).",
"title": "AWS Secret Key",
"type": "string"
}
},
"required": [
"access-key",
"secret-key"
],
"type": "object"
},
{
"properties": {
"oidc-role": {
"description": "OIDC role with access to private Docker images hosted in Amazon Elastic Container Registry (AWS ECR).",
"title": "OpenID Connect Role",
"type": "string"
}
},
"required": ["oidc-role"],
"type": "object"
}
]
}
},
"required": ["aws"],
"type": "object"
}
]
},
"image_base": {
"description": "The parameters of the Docker image to use when running a step.",
"properties": {
"name": { "$ref": "#/components/schemas/image_name" },
"run-as-user": {
"default": 0,
"description": "The UID of a user in the docker image to run as. Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory.",
"title": "User ID",
"type": "integer"
}
},
"required": ["name"],
"title": "Docker Image Configuration",
"type": "object"
},
"image_basic_auth": {
"allOf": [
{ "$ref": "#/components/schemas/image_base" },
{
"properties": {
"password": {
"description": "The password to use when fetching the Docker image.",
"title": "Docker Registry Password",
"type": "string"
},
"username": {
"description": "The username to use when fetching the Docker image.",
"title": "Docker Registry Username",
"type": "string"
}
},
"required": ["username", "password"],
"type": "object"
}
]
},
"image_name": {
"default": "atlassian/default-image:latest",
"description": "The name of the Docker image which may or may not include registry URL, tag, and digest value.",
"title": "Docker Image Name",
"type": "string"
},
"image_no_auth": {
"allOf": [
{ "$ref": "#/components/schemas/image_base" },
{
"properties": {
"aws": { "not": {} },
"password": { "not": {} },
"username": { "not": {} }
},
"type": "object"
}
]
},
"import_inline_pipeline": {
"additionalProperties": false,
"properties": {
"import": {
"description": "The import needs to match the following format: {repo-slug|repo-uuid}:{tag-name|branch-name}:{pipeline-name}.",
"pattern": "^[^:]+:[^:]+:[^:]+$",
"title": "Identifier of the pipeline configuration to import",
"type": "string"
}
},
"required": ["import"],
"type": "object"
},
"import_pipeline": {
"oneOf": [
{ "$ref": "#/components/schemas/import_inline_pipeline" },
{ "$ref": "#/components/schemas/import_source_pipeline" }
]
},
"import_source": {
"additionalProperties": false,
"properties": {
"import": {
"description": "The import needs to match one of the following formats: {file-path} or {repo-slug|repo-uuid}:{tag-name|branch-name} or {repo-slug|repo-uuid}:{tag-name|branch-name}:{file-path}.",
"pattern": "^[^:]+(:[^:]+)?(:[^:]+)?$",
"title": "Location of pipeline configuration to import pipelines from",
"type": "string"
}
},
"required": ["import"],
"type": "object"
},
"import_source_pipeline": {
"additionalProperties": false,
"properties": {
"import": {
"description": "The import needs to match the following format: {pipeline-name}@{import-source-name}.",
"pattern": "^[^@]+@[^@]+$",
"title": "Identifier of the pipeline configuration to import",
"type": "string"
}
},
"required": ["import"],
"type": "object"
},
"items": {
"description": "List of steps, stages and parallel groups of the pipeline.",
"items": {
"oneOf": [
{ "$ref": "#/components/schemas/step_item" },
{ "$ref": "#/components/schemas/parallel_item" },
{ "$ref": "#/components/schemas/stage_item" },
{ "$ref": "#/components/schemas/final_item" }
]
},
"minItems": 1,
"title": "Pipeline Items",
"type": "array"
},
"items_with_variables": {
"description": "List of variables, steps, stages and parallel groups of the custom pipeline.",
"items": {
"oneOf": [
{ "$ref": "#/components/schemas/variables_item" },
{ "$ref": "#/components/schemas/step_item" },
{ "$ref": "#/components/schemas/parallel_item" },
{ "$ref": "#/components/schemas/stage_item" }
]
},
"minItems": 1,
"title": "Custom Pipeline Items",
"type": "array"
},
"max_time": {
"default": 120,
"description": "The maximum time a step can execute for in minutes.",
"example": 60,
"exclusiveMinimum": 0,
"type": "integer"
},
"parallel": {
"oneOf": [
{ "$ref": "#/components/schemas/parallel_steps" },
{ "$ref": "#/components/schemas/parallel_expanded" }
]
},
"parallel_expanded": {
"properties": {
"fail-fast": {
"$ref": "#/components/schemas/fail_fast",
"description": "Stop the whole parallel group in case one of its steps fails."
},
"steps": { "$ref": "#/components/schemas/parallel_steps" }
},
"required": ["steps"],
"type": "object"
},
"parallel_item": {
"additionalProperties": false,
"properties": {
"parallel": { "$ref": "#/components/schemas/parallel" }
},
"type": "object"
},
"parallel_steps": {
"description": "List of steps in the parallel group to run concurrently.",
"items": { "$ref": "#/components/schemas/step_item" },
"minItems": 1,
"title": "Parallel Group Steps",
"type": "array"
},
"pipe": {
"description": "The pipe to execute.",
"example": {
"pipe": "atlassian/test-pipe:2.2.0",
"variables": { "BAZ": ["QUX", "QUZ"], "FOO": "BAR" }
},
"properties": {
"pipe": {
"description": "The full pipe identifier.",
"title": "Pipe Identifier",
"type": "string"
},
"variables": {
"additionalProperties": {
"description": "Environment variable value",
"oneOf": [
{ "type": "string" },
{
"items": { "type": "string" },
"type": "array"
}
]
},
"description": "Environment variables passed to the pipe container.",
"title": "Pipe Variables",
"type": "object"
}
},
"required": ["pipe"],
"title": "Pipe",
"type": "object"
},
"pipeline": {
"oneOf": [
{ "$ref": "#/components/schemas/items" },
{ "$ref": "#/components/schemas/import_pipeline" }
]
},
"pipelines_configuration": {},
"pull_requests_pipeline": {
"oneOf": [
{ "$ref": "#/components/schemas/items" },
{
"properties": {
"destinations": {
"additionalProperties": {
"$ref": "#/components/schemas/pipeline"
},
"type": "object"
}
},
"type": "object"
}
]
},
"runs_on": {
"oneOf": [
{ "$ref": "#/components/schemas/runs_on_item" },
{ "$ref": "#/components/schemas/runs_on_expanded" }
]
},
"runs_on_expanded": {
"description": "Required labels of a runner to run the step.",
"example": ["self.hosted", "linux"],
"items": { "$ref": "#/components/schemas/runs_on_item" },
"maxItems": 10,
"minItems": 1,
"title": "Step Runner Labels",
"type": "array"
},
"runs_on_item": {
"description": "Label of a runner.",
"maxLength": 50,
"title": "Step Runner Label",
"type": "string"
},
"runtime": {
"description": "Custom step runtime",
"properties": {
"cloud": { "$ref": "#/components/schemas/cloud" },
"self-hosted": {
"$ref": "#/components/schemas/self-hosted"
}
},
"title": "Step Runtime",
"type": "object"
},
"script": {
"items": {
"oneOf": [
{
"description": "The command to execute.",
"example": "echo \"hello world\"",
"title": "Script Command",
"type": "string"
},
{ "$ref": "#/components/schemas/pipe" }
]
},
"minItems": 1,
"type": "array"
},
"self-hosted": {
"description": "Custom self-hosted step runtime",
"properties": {
"cpu": {
"description": "Cpu available to runner.",
"title": "Cpu",
"type": "integer"
},
"memory": {
"description": "Memory (mb) available to runner.",
"title": "Memory",
"type": "integer"
},
"storage": {
"oneOf": [
{
"properties": {
"gcp": {
"$ref": "#/components/schemas/storage_gcp_auth"
}
},
"required": ["gcp"],
"type": "object"
},
{
"properties": {
"aws": {
"$ref": "#/components/schemas/storage_aws_auth"
}
},
"required": ["aws"],
"type": "object"
}
]
},
"volumes": {
"default": [],
"description": "Volumes to be mounted into the build container.",
"items": {
"description": "The volume to be mounted into the build container",
"example": "/host-directory:/workdir/path",
"title": "Volume mount",
"type": "string"
},
"type": "array"
}
},
"title": "Self-hosted step runtime",
"type": "object"
},
"service": {
"description": "Custom service properties",
"properties": {
"image": { "$ref": "#/components/schemas/image" },
"memory": {
"default": 1024,
"description": "Memory limit for the service container, in megabytes.",
"minimum": 128,
"title": "Service Memory",
"type": "integer"
},
"type": {
"description": "Specifies Docker service container (to run Docker-in-Docker).",
"enum": ["docker"],
"type": "string"
},
"variables": {
"additionalProperties": {
"description": "Environment variable value",
"title": "Service Variable",
"type": "string"
},
"description": "Environment variables passed to the service container.",
"minProperties": 1,
"title": "Service Variables",
"type": "object"
}
},
"title": "Service definition",
"type": "object"
},
"size": {
"default": "1x",
"description": "The size of the step, sets the amount of resources allocated.",
"enum": ["1x", "2x", "4x", "8x", "16x", "32x"],
"title": "Step Size",
"type": "string"
},
"stage": {
"properties": {
"condition": {
"$ref": "#/components/schemas/condition",
"description": "The condition to execute the stage.",
"title": "Stage Condition"
},
"deployment": {
"description": "The deployment environment for the stage.",
"title": "Stage Deployment Environment",
"type": "string"
},
"environment": {
"description": "The environment for the stage.",
"title": "Stage Environment",
"type": "string"
},
"name": {
"description": "The name of the stage.",
"title": "Stage Name",
"type": "string"
},
"steps": {
"description": "List of steps in the stage.",
"items": {
"properties": {
"step": {
"allOf": [
{
"$ref": "#/components/schemas/step_base"
},
{
"properties": {
"condition": { "not": {} }
},
"type": "object"
}
]
}
},
"type": "object"
},
"minItems": 1,
"title": "Stage Steps",
"type": "array"
},
"trigger": {
"$ref": "#/components/schemas/trigger",
"description": "The trigger used for the pipeline stage.",
"title": "Stage Trigger"
}
},
"required": ["steps"],
"type": "object"
},
"stage_item": {
"additionalProperties": false,
"properties": {
"stage": { "$ref": "#/components/schemas/stage" }
},
"type": "object"
},
"step": {
"allOf": [
{ "$ref": "#/components/schemas/step_base" },
{
"properties": {
"condition": {
"$ref": "#/components/schemas/condition",
"description": "The condition to execute the step.",
"title": "Step Condition"
}
},
"type": "object"
}
]
},
"step_base": {
"properties": {
"after-script": {
"$ref": "#/components/schemas/script",
"description": "List of commands to execute after the step succeeds or fails.",
"title": "Step Post Script"
},
"artifacts": { "$ref": "#/components/schemas/artifacts" },
"caches": {
"description": "Caches enabled for the step.",
"items": {
"description": "Reference to a cache defined under global definitions.",
"title": "Cache Name",
"type": "string"
},
"minItems": 1,
"title": "Step Caches",
"type": "array"
},
"clone": { "$ref": "#/components/schemas/clone" },
"concurrency-group": {
"description": "The concurrency group for the step.",
"maxLength": 50,
"title": "Concurrency group",
"type": "string"
},
"custom": {
"description": "The name of the custom pipeline to run, if the step type is pipeline.",
"title": "Custom",
"type": "string"
},
"deployment": {
"description": "The deployment environment for the step.",
"title": "Step Deployment Environment",
"type": "string"
},
"environment": {
"description": "The environment for the step.",
"title": "Step Environment",
"type": "string"
},
"fail-fast": {
"$ref": "#/components/schemas/fail_fast",
"description": "Stop the parent parallel group in case this step fails."
},
"image": { "$ref": "#/components/schemas/image" },
"input-variables": {
"additionalProperties": {
"description": "input variable value",
"oneOf": [{ "type": "string" }]
},
"description": "Variables from the parent step that are provided to the child pipeline.",
"example": {
"VAR_1": "VALUE_1",
"VAR_2": "${BITBUCKET_BRANCH}"
},
"maxProperties": 20,
"minProperties": 1,
"title": "Input Variables",
"type": "object"
},
"max-time": {
"$ref": "#/components/schemas/max_time",
"title": "Step Maximum Time"
},
"name": {
"description": "The name of the step.",
"example": "Build and test",
"title": "Step Name",
"type": "string"
},
"oidc": {
"description": "Enables the use of OpenID Connect to connect a pipeline step to a resource server.",
"type": "boolean"
},
"runs-on": { "$ref": "#/components/schemas/runs_on" },
"runtime": { "$ref": "#/components/schemas/runtime" },
"script": {
"$ref": "#/components/schemas/script",
"description": "List of commands that are executed in sequence.",
"title": "Step Script"
},
"services": {
"description": "Services enabled for the step.",
"items": {
"description": "Reference to a service defined under global definitions.",
"title": "Service Name",
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"title": "Step Services",
"type": "array"
},
"size": { "$ref": "#/components/schemas/size" },
"trigger": {
"$ref": "#/components/schemas/trigger",
"description": "The trigger used for the pipeline step.",
"title": "Step Trigger"
},
"type": {
"default": "shared",
"description": "The type of the step.",
"enum": ["inline", "pipeline"],
"title": "Step Type",
"type": "string"
}
},
"title": "Pipeline Step",
"type": "object"
},
"step_item": {
"additionalProperties": false,
"properties": {
"step": { "$ref": "#/components/schemas/step" }
},
"type": "object"
},
"storage_aws_auth": {
"description": "Amazon web services self hosted storage",
"oneOf": [
{ "required": ["access-key", "secret-key"] },
{ "required": ["oidc-role"] }
],
"properties": {
"access-key": {
"description": "The AWS access key",
"type": "string"
},
"bucket": {
"description": "The name of the S3 bucket",
"type": "string"
},
"oidc-role": {
"description": "The OIDC role to assume",
"type": "string"
},
"region": {
"description": "The AWS region",
"type": "string"
},
"secret-key": {
"description": "The AWS secret key",
"type": "string"
}
},
"required": ["bucket", "region"],
"title": "Custom aws self hosted storage",
"type": "object"
},
"storage_gcp_auth": {
"description": "Google Cloud Platform self hosted storage",
"properties": {
"bucket": {
"description": "The name of the GCP bucket",
"type": "string"
},
"key-file": {
"description": "The GCP key file contents encoded in Base64 format",
"type": "string"
}
},
"required": ["bucket", "key-file"],
"title": "Custom GCP self hosted storage",
"type": "object"
},
"trigger": {
"default": "automatic",
"enum": ["automatic", "manual"],
"type": "string"
},
"trigger_configuration": {
"description": "Configuration that defines when and which pipelines to trigger.",
"properties": {
"condition": {
"description": "Boolean expression that determines whether the trigger should execute.",
"example": "BITBUCKET_BRANCH == \"main\"",
"title": "Trigger Condition",
"type": "string"
},
"pipelines": {
"description": "List of pipeline names to trigger when the condition is met. Can reference pipelines from the custom section.",
"items": {
"description": "Name of a pipeline defined in the custom pipelines section.",
"title": "Pipeline Name",
"type": "string"
},
"minItems": 1,
"title": "Pipeline Names",
"type": "array"
}
},
"required": ["condition", "pipelines"],
"title": "Trigger Configuration",
"type": "object"
},
"trigger_configuration_list": {
"description": "List of trigger configurations for a specific trigger type.",
"items": {
"$ref": "#/components/schemas/trigger_configuration"
},
"minItems": 1,
"title": "Trigger Configuration List",
"type": "array"
},
"trigger_context": {
"description": "Context of the trigger that started the pipeline. Only returned for pipelines triggered by a parent step.",
"properties": {
"parent_pipeline_run_uuid": {
"description": "The UUID of the pipeline run that contains the parent step that triggered this pipeline.",
"example": "{00000000-0000-0000-0000-000000000000}",
"title": "Parent Pipeline Run UUID",
"type": "string"
},
"parent_pipeline_uuid": {
"description": "The UUID of the pipeline that contains the parent step that triggered this pipeline.",
"example": "{00000000-0000-0000-0000-000000000000}",
"title": "Parent Pipeline UUID",
"type": "string"
},
"parent_step_uuid": {
"description": "The UUID of the parent step that triggered this pipeline.",
"example": "{00000000-0000-0000-0000-000000000000}",
"title": "Parent Step UUID",
"type": "string"
},
"type": {
"description": "The type of trigger that started the pipeline.",
"enum": ["parent_step"],
"title": "Pipeline Trigger",
"type": "string"
}
},
"type": "object"
},
"variables_item": {
"additionalProperties": false,
"properties": {
"variables": {
"description": "List of variables for the custom pipeline.",
"items": {
"description": "Settings for the custom variable.",
"properties": {
"allowed-values": {
"description": "A list of values that are allowed for the variable.",
"items": {
"title": "Allowed Variable Value",
"type": "string"
},
"minItems": 1,
"title": "Allowed Variable Values",
"type": "array"
},
"default": {
"title": "Default Variable Value",
"type": "string"
},
"description": {
"title": "Variable Description",
"type": "string"
},
"name": {
"title": "Variable Name",
"type": "string"
}
},
"required": ["name"],
"title": "Custom Pipeline Variable",
"type": "object"
},
"minItems": 1,
"title": "Custom Pipeline Variables",
"type": "array"
}
},
"type": "object"
}
}
}
}
|