-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
github-workflow.json
1709 lines (1709 loc) · 91.9 KB
/
github-workflow.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
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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/github-workflow.json",
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions",
"additionalProperties": false,
"definitions": {
"architecture": {
"type": "string",
"enum": ["ARM32", "x64", "x86"]
},
"branch": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestbranchestags",
"$ref": "#/definitions/globs",
"description": "When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.\nThe branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nThe patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.\n- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again."
},
"concurrency": {
"type": "object",
"properties": {
"group": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1",
"description": "When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.",
"type": "string"
},
"cancel-in-progress": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1",
"description": "To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
}
},
"required": ["group"],
"additionalProperties": false
},
"configuration": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configuration"
}
},
{
"type": "array",
"items": {
"$ref": "#/definitions/configuration"
}
}
]
},
"container": {
"type": "object",
"properties": {
"image": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerimage",
"description": "The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.",
"type": "string"
},
"credentials": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainercredentials",
"description": "If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerenv",
"$ref": "#/definitions/env",
"description": "Sets an array of environment variables in the container."
},
"ports": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerports",
"description": "Sets an array of ports to expose on the container.",
"type": "array",
"items": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minItems": 1
},
"volumes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainervolumes",
"description": "Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.\nTo specify a volume, you specify the source and destination path: <source>:<destinationPath>\nThe <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[^:]+:[^:]+$"
},
"minItems": 1
},
"options": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontaineroptions",
"description": "Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.",
"type": "string"
}
},
"required": ["image"],
"additionalProperties": false
},
"defaults": {
"type": "object",
"properties": {
"run": {
"type": "object",
"properties": {
"shell": {
"$ref": "#/definitions/shell"
},
"working-directory": {
"$ref": "#/definitions/working-directory"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"minProperties": 1,
"additionalProperties": false
},
"permissions": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions",
"description": "You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.",
"oneOf": [
{
"type": "string",
"enum": ["read-all", "write-all"]
},
{
"$ref": "#/definitions/permissions-event"
}
]
},
"permissions-event": {
"type": "object",
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/permissions-level"
},
"attestations": {
"$ref": "#/definitions/permissions-level"
},
"checks": {
"$ref": "#/definitions/permissions-level"
},
"contents": {
"$ref": "#/definitions/permissions-level"
},
"deployments": {
"$ref": "#/definitions/permissions-level"
},
"discussions": {
"$ref": "#/definitions/permissions-level"
},
"id-token": {
"$ref": "#/definitions/permissions-level"
},
"issues": {
"$ref": "#/definitions/permissions-level"
},
"packages": {
"$ref": "#/definitions/permissions-level"
},
"pages": {
"$ref": "#/definitions/permissions-level"
},
"pull-requests": {
"$ref": "#/definitions/permissions-level"
},
"repository-projects": {
"$ref": "#/definitions/permissions-level"
},
"security-events": {
"$ref": "#/definitions/permissions-level"
},
"statuses": {
"$ref": "#/definitions/permissions-level"
}
}
},
"permissions-level": {
"type": "string",
"enum": ["read", "write", "none"]
},
"env": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/environment-variables",
"description": "To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"$ref": "#/definitions/stringContainingExpressionSyntax"
}
]
},
"environment": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment",
"description": "The environment that the job references",
"type": "object",
"properties": {
"name": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-a-single-environment-name",
"description": "The name of the environment configured in the repo.",
"type": "string"
},
"url": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-environment-name-and-url",
"description": "A deployment URL",
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
},
"event": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows",
"type": "string",
"enum": [
"branch_protection_rule",
"check_run",
"check_suite",
"create",
"delete",
"deployment",
"deployment_status",
"discussion",
"discussion_comment",
"fork",
"gollum",
"issue_comment",
"issues",
"label",
"merge_group",
"milestone",
"page_build",
"project",
"project_card",
"project_column",
"public",
"pull_request",
"pull_request_review",
"pull_request_review_comment",
"pull_request_target",
"push",
"registry_package",
"release",
"status",
"watch",
"workflow_call",
"workflow_dispatch",
"workflow_run",
"repository_dispatch"
]
},
"eventObject": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"additionalProperties": true
},
"expressionSyntax": {
"$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)",
"type": "string",
"pattern": "^\\$\\{\\{(.|[\r\n])*\\}\\}$"
},
"stringContainingExpressionSyntax": {
"$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)",
"type": "string",
"pattern": "^.*\\$\\{\\{(.|[\r\n])*\\}\\}.*$"
},
"globs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"machine": {
"type": "string",
"enum": ["linux", "macos", "windows"]
},
"name": {
"type": "string",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"path": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths",
"$ref": "#/definitions/globs",
"description": "When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.\nThe paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths."
},
"ref": {
"properties": {
"branches": {
"$ref": "#/definitions/branch"
},
"branches-ignore": {
"$ref": "#/definitions/branch"
},
"tags": {
"$ref": "#/definitions/branch"
},
"tags-ignore": {
"$ref": "#/definitions/branch"
},
"paths": {
"$ref": "#/definitions/path"
},
"paths-ignore": {
"$ref": "#/definitions/path"
}
},
"oneOf": [
{
"type": "object",
"allOf": [
{
"not": {
"required": ["branches", "branches-ignore"]
}
},
{
"not": {
"required": ["tags", "tags-ignore"]
}
},
{
"not": {
"required": ["paths", "paths-ignore"]
}
}
]
},
{
"type": "null"
}
]
},
"shell": {
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",
"description": "You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.",
"anyOf": [
{
"type": "string"
},
{
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#custom-shell",
"type": "string",
"enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]
}
]
},
"step": {
"type": "object",
"additionalProperties": false,
"dependencies": {
"working-directory": ["run"],
"shell": ["run"]
},
"oneOf": [
{
"required": ["uses"]
},
{
"required": ["run"]
}
],
"properties": {
"id": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid",
"description": "A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": "string"
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsif",
"description": "You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"name": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsname",
"description": "A name for your step to display on GitHub.",
"type": "string"
},
"uses": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsuses",
"description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/).\nWe strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.\n- Using the commit SHA of a released action version is the safest for stability and security.\n- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.\n- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.\nSome actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.\nActions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions.",
"type": "string"
},
"run": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsrun",
"description": "Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.\nCommands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.\nEach run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.",
"type": "string"
},
"working-directory": {
"$ref": "#/definitions/working-directory"
},
"shell": {
"$ref": "#/definitions/shell"
},
"with": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswith",
"$ref": "#/definitions/env",
"description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.",
"properties": {
"args": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithargs",
"type": "string"
},
"entrypoint": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithentrypoint",
"type": "string"
}
}
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv",
"$ref": "#/definitions/env",
"description": "Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job."
},
"continue-on-error": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error",
"description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"default": false
},
"timeout-minutes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes",
"description": "The maximum number of minutes to run the step before killing the process.",
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
}
}
},
"types": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onevent_nametypes",
"description": "Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.\nYou can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.",
"type": "array",
"minItems": 1
},
"working-directory": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun",
"description": "Using the working-directory keyword, you can specify the working directory of where to run the command.",
"type": "string"
},
"jobNeeds": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idneeds",
"description": "Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/name"
},
"minItems": 1
},
{
"$ref": "#/definitions/name"
}
]
},
"matrix": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix",
"description": "A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.\nYou can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.\nWhen you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"oneOf": [
{
"type": "object",
"patternProperties": {
"^(in|ex)clude$": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#example-including-configurations-in-a-matrix-build",
"oneOf": [
{
"$ref": "#/definitions/expressionSyntax"
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configuration"
}
},
"minItems": 1
}
]
}
},
"additionalProperties": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/configuration"
},
"minItems": 1
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"minProperties": 1
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"reusableWorkflowCallJob": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#calling-a-reusable-workflow",
"description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname",
"description": "The name of the job displayed on GitHub.",
"type": "string"
},
"needs": {
"$ref": "#/definitions/jobNeeds"
},
"permissions": {
"$ref": "#/definitions/permissions"
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif",
"description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"uses": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_iduses",
"description": "The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.",
"type": "string",
"pattern": "^(.+\\/)+(.+)\\.(ya?ml)(@.+)?$"
},
"with": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith",
"$ref": "#/definitions/env",
"description": "A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.<job_id>.steps[*].with', the inputs you pass with 'jobs.<job_id>.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context."
},
"secrets": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idsecrets",
"description": "When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow.",
"oneOf": [
{
"$ref": "#/definitions/env"
},
{
"type": "string",
"enum": ["inherit"]
}
]
},
"strategy": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy",
"description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.",
"type": "object",
"properties": {
"matrix": {
"$ref": "#/definitions/matrix"
},
"fail-fast": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast",
"description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true",
"type": ["boolean", "string"],
"default": true
},
"max-parallel": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel",
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.",
"type": ["number", "string"]
}
},
"required": ["matrix"],
"additionalProperties": false
},
"concurrency": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/concurrency"
}
]
}
},
"required": ["uses"],
"additionalProperties": false
},
"normalJob": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_id",
"description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname",
"description": "The name of the job displayed on GitHub.",
"type": "string"
},
"needs": {
"$ref": "#/definitions/jobNeeds"
},
"permissions": {
"$ref": "#/definitions/permissions"
},
"runs-on": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on",
"description": "The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.",
"anyOf": [
{
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#github-hosted-runners",
"type": "string"
},
{
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#self-hosted-runners",
"type": "array",
"anyOf": [
{
"items": [
{
"type": "string"
}
],
"minItems": 1
}
]
},
{
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-runners-in-a-group",
"type": "object",
"properties": {
"group": {
"type": "string"
},
"labels": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
{
"$ref": "#/definitions/stringContainingExpressionSyntax"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"environment": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment",
"description": "The environment that the job references.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/environment"
}
]
},
"outputs": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idoutputs",
"description": "A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"minProperties": 1
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idenv",
"$ref": "#/definitions/env",
"description": "A map of environment variables that are available to all steps in the job."
},
"defaults": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_iddefaults",
"$ref": "#/definitions/defaults",
"description": "A map of default settings that will apply to all steps in the job."
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif",
"description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"steps": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps",
"description": "A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.\nMust contain either `uses` or `run`\n",
"type": "array",
"items": {
"$ref": "#/definitions/step"
},
"minItems": 1
},
"timeout-minutes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes",
"description": "The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360",
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"default": 360
},
"strategy": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy",
"description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.",
"type": "object",
"properties": {
"matrix": {
"$ref": "#/definitions/matrix"
},
"fail-fast": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast",
"description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true",
"type": ["boolean", "string"],
"default": true
},
"max-parallel": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel",
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.",
"type": ["number", "string"]
}
},
"required": ["matrix"],
"additionalProperties": false
},
"continue-on-error": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error",
"description": "Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"container": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer",
"description": "A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.\nIf you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/container"
}
]
},
"services": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idservices",
"description": "Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.\nWhen you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.\nWhen both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/container"
}
},
"concurrency": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/concurrency"
}
]
}
},
"required": ["runs-on"],
"additionalProperties": false
}
},
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#name",
"description": "The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.",
"type": "string"
},
"on": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#on",
"description": "The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.",
"oneOf": [
{
"$ref": "#/definitions/event"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/event"
},
"minItems": 1
},
{
"type": "object",
"properties": {
"branch_protection_rule": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#branch_protection_rule",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"check_run": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-run-event-check_run",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"rerequested",
"completed",
"requested_action"
]
},
"default": [
"created",
"rerequested",
"completed",
"requested_action"
]
}
}
},
"check_suite": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-suite-event-check_suite",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["completed", "requested", "rerequested"]
},
"default": ["completed", "requested", "rerequested"]
}
}
},
"create": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#create-event-create",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference."
},
"delete": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#delete-event-delete",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference."
},
"deployment": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#deployment-event-deployment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/."
},
"deployment_status": {
"$comment": "https://docs.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status."
},
"discussion": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"category_changed",
"answered",
"unanswered"
]
},
"default": [
"created",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"category_changed",
"answered",
"unanswered"
]
}
}
},
"discussion_comment": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion_comment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]