-
Notifications
You must be signed in to change notification settings - Fork 91
/
flatpak-manifest.schema.json
1515 lines (1515 loc) · 56.4 KB
/
flatpak-manifest.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
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:https://json-schema.org/draft-07/schema",
"$comment": "https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html#flatpak-manifest",
"title": "flatpak-builder manifest",
"$defs": {
"ignored-prop": {
"custom": {
"description": "Custom property (ignored by flatpak-builder)"
},
"comment": {
"description": "Comment property (ignored by flatpak-builder)"
},
"schema": {
"description": "JSON schema (ignored by flatpak-builder)"
}
},
"build-options": {
"description": "Object specifying the build environment.",
"type": "object",
"properties": {
"cflags": {
"description": "This is set in the environment variable CFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.",
"type": "string"
},
"cflags-override": {
"description": "If this is true, clear cflags from previous build options before adding it from these options.",
"type": "boolean"
},
"cppflags": {
"description": "This is set in the environment variable CPPFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.",
"type": "string"
},
"cppflags-override": {
"description": "If this is true, clear cppflags from previous build options before adding it from these options.",
"type": "boolean"
},
"cxxflags": {
"description": "This is set in the environment variable CXXFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.",
"type": "string"
},
"cxxflags-override": {
"description": "If this is true, clear cxxflags from previous build options before adding it from these options.",
"type": "boolean"
},
"ldflags": {
"description": "This is set in the environment variable LDFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.",
"type": "string"
},
"ldflags-override": {
"description": "If this is true, clear ldflags from previous build options before adding it from these options.",
"type": "boolean"
},
"prefix": {
"description": "The build prefix for the modules (defaults to /app for applications and /usr for runtimes).",
"type": "string"
},
"libdir": {
"description": "The build libdir for the modules (defaults to /app/lib for applications and /usr/lib for runtimes).",
"type": "string"
},
"append-path": {
"description": "This will get appended to PATH in the build environment (with an leading colon if needed).",
"type": "string"
},
"prepend-path": {
"description": "This will get prepended to PATH in the build environment (with an trailing colon if needed).",
"type": "string"
},
"append-ld-library-path": {
"description": "This will get appended to LD_LIBRARY_PATH in the build environment (with an leading colon if needed).",
"type": "string"
},
"prepend-ld-library-path": {
"description": "This will get prepended to LD_LIBRARY_PATH in the build environment (with an trailing colon if needed).",
"type": "string"
},
"append-pkg-config-path": {
"description": "This will get appended to PKG_CONFIG_PATH in the build environment (with an leading colon if needed).",
"type": "string"
},
"prepend-pkg-config-path": {
"description": "This will get prepended to PKG_CONFIG_PATH in the build environment (with an trailing colon if needed).",
"type": "string"
},
"env": {
"description": "This is a dictionary defining environment variables to be set during the build. Elements in this override the properties that set the environment, like cflags and ldflags. Keys with a null value unset the corresponding variable.",
"type": "object",
"patternProperties": {
"^[^=]+$": {
"description": "An environment variable.",
"type": "string"
}
},
"additionalProperties": false
},
"secret-env": {
"description": "This is a array defining which host environment variables is transfered to build-commands or post-install environment.",
"type": "array",
"items": {
"description": "Host environment variable to transfer.",
"type": "string"
}
},
"build-args": {
"description": "This is an array containing extra options to pass to flatpak build.",
"type": "array",
"items": {
"description": "Extra option to pass to flatpak build.",
"type": "string"
}
},
"test-args": {
"description": "Similar to build-args but affects the tests, not the normal build.",
"type": "array",
"items": {
"description": "Similar to build-arg but affects the tests, not the normal build.",
"type": "string"
}
},
"config-opts": {
"description": "This is an array containing extra options to pass to configure.",
"type": "array",
"items": {
"description": "Extra option to pass to configure.",
"type": "string"
}
},
"secret-opts": {
"description": "This is an array of options that will be passed to configure, meant to be used to pass secrets through host environment variables. Put the option with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'",
"type": "array",
"items": {
"description": "Extra option to pass to configure.",
"type": "string"
}
},
"make-args": {
"description": "An array of extra arguments that will be passed to make.",
"type": "array",
"items": {
"description": "Extra argument that will be passed to make.",
"type": "string"
}
},
"make-install-args": {
"description": "An array of extra arguments that will be passed to make install.",
"type": "array",
"items": {
"description": "Extra argument that will be passed to make install.",
"type": "string"
}
},
"strip": {
"description": "If this is true (the default is false) then all ELF files will be stripped after install.",
"type": "boolean"
},
"no-debuginfo": {
"description": "By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files and puts this in an extension. If you want to disable this, set no-debuginfo to true.",
"type": "boolean"
},
"no-debuginfo-compression": {
"description": "By default when extracting debuginfo we compress the debug sections. If you want to disable this, set no-debuginfo-compression to true.",
"type": "boolean"
},
"arch": {
"description": "This is a dictionary defining for each arch a separate build options object that override the main one.",
"type": "object",
"patternProperties": {
".*": {
"$ref": "#/$defs/build-options"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"extension": {
"description": "Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files which are available during runtime.",
"type": "object",
"properties": {
"directory": {
"description": "The directory where the extension is mounted. If the extension point is for an application, this path is relative to /app, otherwise it is relative to /usr.",
"type": "string"
},
"bundle": {
"description": "If this is true, then the data created in the extension directory is omitted from the result, and instead packaged in a separate extension.",
"type": "boolean"
},
"remove-after-build": {
"description": "If this is true, the extension is removed when finishing. This is only interesting for extensions in the add-build-extensions property.",
"type": "boolean"
},
"autodelete": {
"description": "Whether to automatically delete extensions matching this extension point when deleting a 'related' application or runtime. Available since 0.6.7.",
"type": "boolean"
},
"no-autodownload": {
"description": "Whether to automatically download extensions matching this extension point when updating or installing a 'related' application or runtime. Available since 0.6.7.",
"type": "boolean"
},
"subdirectories": {
"description": "If this key is set to true, then flatpak will look for extensions whose name is a prefix of the extension point name, and mount them at the corresponding name below the subdirectory. Available since 0.1.",
"type": "boolean"
},
"add-ld-path": {
"description": "A condition that must be true for the extension to be auto-downloaded. As of 1.1.1 this supports multiple conditions separated by semi-colons.",
"type": "string"
},
"download-if": {
"description": "A condition that must be true for the extension to be auto-downloaded.",
"type": "string",
"anyOf": [
{
"enum": [
"active-gl-driver",
"active-gtk-theme",
"have-intel-gpu"
]
},
{
"pattern": "^have-kernel-module-.*"
},
{
"pattern": "^on-xdg-desktop-.*"
}
]
},
"enable-if": {
"description": "A condition that must be true for the extension to be enabled. As of 1.1.1 this supports multiple conditions separated by semi-colons.",
"type": "string",
"anyOf": [
{
"enum": [
"active-gl-driver",
"active-gtk-theme",
"have-intel-gpu"
]
},
{
"pattern": "^have-kernel-module-.*"
},
{
"pattern": "^on-xdg-desktop-.*"
}
]
},
"autoprune-unless": {
"description": "A condition that must be false for the extension to be considered unused when pruning. For example, flatpak uninstall --unused uses this information.",
"type": "string",
"anyOf": [
{
"enum": [
"active-gl-driver",
"active-gtk-theme",
"have-intel-gpu"
]
},
{
"pattern": "^have-kernel-module-.*"
},
{
"pattern": "^on-xdg-desktop-.*"
}
]
},
"merge-dirs": {
"description": "A list of relative paths of directories below the extension point directory that will be merged. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3.",
"type": "string"
},
"subdirectory-suffix": {
"description": "A suffix that gets appended to the directory name. This is very useful when the extension point naming scheme is reversed. For example, an extension point for GTK+ themes would be /usr/share/themes/$NAME/gtk-3.0, which could be achieved using subdirectory-suffix=gtk-3.0. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3.",
"type": "string"
},
"locale-subset": {
"description": "If set, then the extensions are partially downloaded by default, based on the currently configured locales. This means that the extension contents should be a set of directories with the language code as name. Available since 0.9.13 (and 0.6.6 for any extensions called *.Locale) ",
"type": "boolean"
},
"version": {
"description": "The branch to use when looking for the extension. If this is not specified, it defaults to the branch of the application or runtime that the extension point is for. Available since 0.4.1.",
"type": "string"
},
"versions": {
"description": "The branches to use when looking for the extension. If this is not specified, it defaults to the branch of the application or runtime that the extension point is for. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.4.",
"type": "string"
}
},
"additionalProperties": false
},
"module": {
"description": "Each module specifies a source that has to be separately built and installed. It contains the build options and a list of sources to download and extract before building. Modules can be nested, in order to turn related modules on and off with a single key.",
"type": "object",
"properties": {
"name": {
"description": "The name of the module, used in e.g. build logs. The name is also used for constructing filenames and commandline arguments, therefore using spaces or '/' in this string is a bad idea.",
"type": "string"
},
"disabled": {
"description": "If true, skip this module.",
"type": "boolean"
},
"sources": {
"description": "An array of objects defining sources that will be downloaded and extracted in order. String members in the array are interpreted as the name of a separate json or yaml file that contains sources.",
"type": "array",
"items": {
"if": {
"type": "object"
},
"then": {
"$ref": "#/$defs/source"
},
"else": {
"type": "string",
"description": "Name of a separate json or yaml file that contains sources."
}
}
},
"config-opts": {
"description": "An array of options that will be passed to configure.",
"type": "array",
"items": {
"description": "Option that will be passed to configure.",
"type": "string"
}
},
"secret-opts": {
"description": "An array of options that will be passed to configure, meant to be used to pass secrets through host environment variables. Put the option with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'",
"type": "array",
"items": {
"description": "Extra option to pass to configure.",
"type": "string"
}
},
"make-args": {
"description": "An array of arguments that will be passed to make.",
"type": "array",
"items": {
"description": "Argument that will be passed to make.",
"type": "string"
}
},
"make-install-args": {
"description": "An array of arguments that will be passed to make install",
"type": "array",
"items": {
"description": "Argument that will be passed to make install",
"type": "string"
}
},
"rm-configure": {
"description": "If true, remove the configure script before starting build",
"type": "boolean"
},
"no-autogen": {
"description": "Ignore the existence of an autogen script.",
"type": "boolean"
},
"no-parallel-make": {
"description": "Don't call make with arguments to build in parallel",
"type": "boolean"
},
"install-rule": {
"description": "Name of the rule passed to make for the install phase, default is install",
"type": "string"
},
"no-make-install": {
"description": "Don't run the make install (or equivalent) stage.",
"type": "boolean"
},
"no-python-timestamp-fix": {
"description": "Don't fix up the *.py[oc] header timestamps for ostree use.",
"type": "boolean"
},
"cmake": {
"description": "Use cmake instead of configure (deprecated: use buildsystem instead).",
"deprecated": true,
"type": "boolean"
},
"buildsystem": {
"description": "Build system to use: autotools, cmake, cmake-ninja, meson, simple, qmake",
"type": "string",
"enum": [
"autotools",
"cmake",
"cmake-ninja",
"meson",
"simple",
"qmake"
]
},
"builddir": {
"description": "Use a build directory that is separate from the source directory.",
"type": "boolean"
},
"subdir": {
"description": "Build inside this subdirectory of the extracted sources.",
"type": "string"
},
"build-options": {
"$ref": "#/$defs/build-options"
},
"build-commands": {
"description": "An array of commands to run during build (between make and make install if those are used). This is primarily useful when using the simple buildsystem. Each command is run in /bin/sh -c, so it can use standard POSIX shell syntax such as piping output.",
"type": "array",
"items": {
"description": "Command to run during build (between make and make install if those are used). This is primarily useful when using the simple buildsystem. Each command is run in /bin/sh -c, so it can use standard POSIX shell syntax such as piping output.",
"type": "string"
}
},
"post-install": {
"description": "An array of shell commands that are run after the install phase. Can for example clean up the install dir, or install extra files.",
"type": "array",
"items": {
"description": "Shell command that is run after the install phase. Can for example clean up the install dir, or install extra files.",
"type": "string"
}
},
"cleanup": {
"description": "An array of file patterns that should be removed at the end. Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match the basename. Note that any patterns will only match files installed by this module.",
"type": "array",
"items": {
"description": "File pattern that should be removed at the end. Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match the basename. Note that any patterns will only match files installed by this module.",
"type": "string"
}
},
"ensure-writable": {
"description": "The way the builder works is that files in the install directory are hard-links to the cached files, so you're not allowed to modify them in-place. If you list a file in this then the hardlink will be broken and you can modify it. This is a workaround, ideally installing files should replace files, not modify existing ones.",
"type": "array",
"items": {
"description": "The way the builder works is that files in the install directory are hard-links to the cached files, so you're not allowed to modify them in-place. If you list a file in this then the hardlink will be broken and you can modify it. This is a workaround, ideally installing files should replace files, not modify existing ones.",
"type": "string"
}
},
"only-arches": {
"description": "If non-empty, only build the module on the arches listed.",
"type": "array",
"items": {
"description": "If non-empty, only build the module on the arches listed.",
"type": "string"
}
},
"skip-arches": {
"description": "Don't build on any of the arches listed.",
"type": "array",
"items": {
"description": "Don't build on any of the arches listed.",
"type": "string"
}
},
"cleanup-platform": {
"description": "Extra files to clean up in the platform.",
"type": "array",
"items": {
"description": "Extra file to clean up in the platform.",
"type": "string"
}
},
"run-tests": {
"description": "If true this will run the tests after installing.",
"type": "boolean"
},
"test-rule": {
"description": "The target to build when running the tests. Defaults to 'check' for make and 'test' for ninja. Set to empty to disable.",
"type": "string"
},
"test-commands": {
"description": "Array of commands to run during the tests.",
"type": "array",
"items": {
"description": "Command to run during the tests.",
"type": "string"
}
},
"modules": {
"description": "An array of objects specifying the modules to be built in order. String members in the array are interpreted as the name of a separate json or yaml file that contains a module.",
"type": "array",
"items": {
"if": {
"type": "object"
},
"then": {
"$ref": "#/$defs/module"
},
"else": {
"type": "string",
"description": "Name of a separate json or yaml file that contains a module."
}
}
}
},
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"required": [
"name"
],
"additionalProperties": false
},
"source": {
"description": " These contain a pointer to the source that will be extracted into the source directory before the build starts. They can be of several types, distinguished by the type property. Additionally, the sources list can contain a plain string, which is interpreted as the name of a separate json or yaml file that is read and inserted at this point. The file can contain a single source, or an array of sources.",
"type": "object",
"allOf": [
{
"properties": {
"only-arches": {
"description": "If non-empty, only build the module on the arches listed.",
"type": "array",
"items": {
"description": "If non-empty, only build the module on the arches listed.",
"type": "string"
}
},
"skip-arches": {
"description": "Don't build on any of the arches listed.",
"type": "array",
"items": {
"description": "Don't build on this arch.",
"type": "string"
}
},
"dest": {
"description": "Directory inside the source dir where this source will be extracted.",
"type": "string"
},
"type": {
"description": "Type of the source.",
"type": "string",
"enum": [
"archive",
"git",
"bzr",
"svn",
"dir",
"file",
"script",
"inline",
"shell",
"patch",
"extra-data"
]
}
},
"required": [
"type"
]
},
{
"if": {
"properties": {
"type": {
"const": "archive"
}
}
},
"then": {
"$ref": "#/$defs/source-archive"
}
},
{
"if": {
"properties": {
"type": {
"const": "git"
}
}
},
"then": {
"$ref": "#/$defs/source-git"
}
},
{
"if": {
"properties": {
"type": {
"const": "bzr"
}
}
},
"then": {
"$ref": "#/$defs/source-bzr"
}
},
{
"if": {
"properties": {
"type": {
"const": "svn"
}
}
},
"then": {
"$ref": "#/$defs/source-svn"
}
},
{
"if": {
"properties": {
"type": {
"const": "dir"
}
}
},
"then": {
"$ref": "#/$defs/source-dir"
}
},
{
"if": {
"properties": {
"type": {
"const": "file"
}
}
},
"then": {
"$ref": "#/$defs/source-file"
}
},
{
"if": {
"properties": {
"type": {
"const": "script"
}
}
},
"then": {
"$ref": "#/$defs/source-script"
}
},
{
"if": {
"properties": {
"type": {
"const": "inline"
}
}
},
"then": {
"$ref": "#/$defs/source-inline"
}
},
{
"if": {
"properties": {
"type": {
"const": "shell"
}
}
},
"then": {
"$ref": "#/$defs/source-shell"
}
},
{
"if": {
"properties": {
"type": {
"const": "patch"
}
}
},
"then": {
"$ref": "#/$defs/source-patch"
}
},
{
"if": {
"properties": {
"type": {
"const": "extra-data"
}
}
},
"then": {
"$ref": "#/$defs/source-extra-data"
}
}
]
},
"source-archive": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"path": {
"description": "The path of the archive.",
"type": "string"
},
"url": {
"description": "The URL of a remote archive that will be downloaded. This overrides path if both are specified.",
"type": "string"
},
"mirror-urls": {
"description": "A list of alternative urls that are used if the main url fails.",
"type": "array",
"items": {
"description": "Alternative url that is used if the main url fails.",
"type": "string"
}
},
"referer": {
"description": "Sets the HTTP \"Referer\" header when downloading the archive.",
"type": "string"
},
"disable-http-decompression": {
"description": "Disables decompression of downloads over HTTP for misconfigured servers.",
"type": "boolean"
},
"archive-type": {
"description": "The type of archive if it cannot be guessed from the path.",
"type": "string",
"enum": [
"rpm",
"tar",
"tar-gzip",
"tar-compress",
"tar-bzip2",
"tar-lzip",
"tar-lzma",
"tar-lzop",
"tar-xz",
"tar-zst",
"zip",
"7z"
]
},
"git-init": {
"description": "Whether to initialise the repository as a git repository.",
"type": "boolean"
},
"md5": {
"description": "The md5 checksum of the file, verified after download. Note that md5 is no longer considered a safe checksum, we recommend you use at least sha256.",
"deprecated": true,
"type": "string"
},
"sha1": {
"description": "The sha1 checksum of the file, verified after download. Note that sha1 is no longer considered a safe checksum, we recommend you use at least sha256.",
"deprecated": true,
"type": "string"
},
"sha256": {
"description": "The sha256 checksum of the file, verified after download.",
"type": "string"
},
"sha512": {
"description": "The sha512 checksum of the file, verified after download.",
"type": "string"
},
"strip-components": {
"description": "The number of initial pathname components to strip during extraction. Defaults to 1.",
"type": "integer"
},
"dest-filename": {
"description": "Filename to for the downloaded file, defaults to the basename of url.",
"type": "string"
}
},
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"oneOf": [
{ "required": [ "url" ] },
{ "required": [ "path" ] }
],
"dependencies": {
"url": {
"anyOf": [
{ "required": [ "sha256" ] },
{ "required": [ "sha512" ] },
{ "required": [ "sha1" ] },
{ "required": [ "md5" ] }
]
}
},
"additionalProperties": false
},
"source-git": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"path": {
"description": "The path to a local checkout of the git repository. Due to how git-clone works, this will be much faster than specifying a URL of file:https:///...",
"type": "string"
},
"url": {
"description": "URL of the git repository. This overrides path if both are specified. When using git via SSH, the correct syntax is ssh:https://user@domain/path/to/repo.git.",
"type": "string"
},
"branch": {
"description": "The branch to use from the git repository.",
"type": "string"
},
"tag": {
"description": "The tag to use from the git repository.",
"type": "string"
},
"commit": {
"description": "The commit to use from the git repository. If branch is also specified, then it is verified that the branch/tag is at this specific commit. This is a readable way to document that you're using a particular tag, but verify that it does not change.",
"type": "string"
},
"disable-fsckobjects": {
"description": "Don't use transfer.fsckObjects=1 to mirror git repository. This may be needed for some (broken) repositories.",
"type": "boolean"
},
"disable-shallow-clone": {
"description": "Don't optimize by making a shallow clone when downloading the git repo.",
"type": "boolean"
},
"disable-submodules": {
"description": "Don't checkout the git submodules when cloning the repository.",
"type": "boolean"
}
},
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"oneOf": [
{ "required": [ "url" ] },
{ "required": [ "path" ] }
],
"additionalProperties": false
},
"source-bzr": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"url": {
"description": "URL of the bzr repository.",
"type": "string"
},
"branch": {
"description": "A specific revision to use in the branch.",
"type": "string"
}
},
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"required": [
"url"
],
"additionalProperties": false
},
"source-svn": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"url": {
"description": "URL of the svn repository, including branch/tag part.",
"type": "string"
},
"revision": {
"description": "A specific revision number to use.",
"type": "string"
}
},
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"required": [
"url"
],
"additionalProperties": false
},
"source-dir": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"path": {
"description": "The path of a local directory whose content will be copied into the source dir. Note that directory sources don't currently support caching, so they will be rebuilt each time.",
"type": "string"
},
"skip": {
"description": "Source files to ignore in the directory.",
"type": "array",
"items": {
"description": "Source file to ignore in the directory.",
"type": "string"
}
}
},
"required": [
"path"
],
"patternProperties": {
"^x-.*": { "$ref": "#/$defs/ignored-prop/custom" },
"^//.*": { "$ref": "#/$defs/ignored-prop/comment" }
},
"additionalProperties": false
},
"source-file": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/source/allOf/0/properties/type"
},
"only-arches": {
"$ref": "#/$defs/source/allOf/0/properties/only-arches"
},
"skip-arches": {
"$ref": "#/$defs/source/allOf/0/properties/skip-arches"
},
"dest": {
"$ref": "#/$defs/source/allOf/0/properties/dest"
},
"path": {
"description": "The path of a local file that will be copied into the source dir.",
"type": "string"
},
"url": {
"description": "The URL of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.",
"type": "string"
},
"referer": {
"description": "Sets the HTTP \"Referer\" header when downloading the file.",
"type": "string"
},
"disable-http-decompression": {
"description": "Disables decompression of downloads over HTTP for misconfigured servers.",
"type": "boolean"
},
"mirror-urls": {
"description": "A list of alternative urls that are used if the main url fails.",
"type": "array",
"items": {
"description": "Alternative url that is used if the main url fails.",
"type": "string"
}
},
"md5": {
"description": "The md5 checksum of the file, verified after download. Note that md5 is no longer considered a safe checksum, we recommend you use at least sha256.",
"deprecated": true,
"type": "string"
},
"sha1": {
"description": "The sha1 checksum of the file, verified after download. Note that sha1 is no longer considered a safe checksum, we recommend you use at least sha256.",
"deprecated": true,
"type": "string"
},
"sha256": {
"description": "The sha256 checksum of the file, verified after download.",