summaryrefslogtreecommitdiff
path: root/package_source-2.schema.json
blob: 4d8249d4719d8fc650f07aaaae496676b1faa313 (plain)
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
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://hydrilla.koszko.org/schemas/package_source-2.schema.json",
    "title": "Package source",
    "description": "Definition of a Hydrilla source package",
    "type": "object",
    "required": [
	"$schema",
	"source_name",
	"copyright",
	"upstream_url",
	"definitions"
    ],
    "properties": {
	"$schema": {
	    "description": "Mark this instance as conforming to package source schema 2.x",
	    "type": "string",
	    "pattern": "^https://hydrilla\\.koszko\\.org/schemas/package_source-2\\.(([1-9][0-9]*|0)\\.)*schema\\.json$"
	},
	"source_name": {
	    "$ref": "./common_definitions-2.schema.json#/definitions/source_name"
	},
	"copyright":  {
	    "description": "Which files from the source package indicate its license terms and should be included in the distribution packages",
	    "$ref": "./common_definitions-2.schema.json#/definitions/file_ref_list"
	},
	"upstream_url": {
	    "description": "Where this software/work initially comes from",
	    "type": "string"
	},
	"piggyback_on": {
	    "description": "Specify packages from other software system that should be used for constructing this package",
	    "anyOf": [{
		"$ref": "#/definitions/piggyback_apt"
	    }]
	},
	"comment": {
	    "$ref": "./common_definitions-2.schema.json#/definitions/comment"
	},
	"definitions": {
	    "description": "Definitions of site resources and pattern->payload mappings (possibly combined together)",
	    "type": "array",
	    "items": {
		"$ref": "#/definitions/item_definition"
	    }
	},
	"additional_files": {
	    "description": "Files which should be included in the source archive produced by Hydrilla builder in addition to script and copyright files",
	    "$ref": "./common_definitions-2.schema.json#/definitions/file_ref_list",
	    "default": []
	},
	"reuse_generate_spdx_report": {
	    "description": "Should report.spdx be automatically generated for the package using REUSE tool",
	    "type": "boolean",
	    "default": false
	}
    },
    "definitions": {
	"piggyback_apt": {
	    "description": "Specify packages from APT software system that should be used for constructing this package",
	    "type": "object",
	    "required": [
		"system",
		"packages",
		"dependencies"
	    ],
	    "properties": {
		"system": {
		    "description": "Which software system to use",
		    "const": "apt"
		},
		"distribution": {
		    "description": "Which pre-defined APT-based distribution to use (currently the only available one is Trisquel 10 Nabia)",
		    "const": "nabia"
		},
		"sources_list": {
		    "description": "What lines should be added to the sources.list file that will be generated; those will be used together with pre-defined lines for chosen distribution (if any)",
		    "type": "array",
		    "items": {
			"description": "A sources.list line like \"deb-src http://archive.trisquel.info/trisquel/ nabia main\"",
			"type": "string",
			"pattern": "^deb(-src)?(\\s+[^\\s]+){3}$"
		    },
		    "default": []
		},
		"trusted_keys": {
		    "description": "Fingerprints of additional PGP keys that should be used with supplied sources.list entries",
		    "type": "array",
		    "items": {
			"description": "A PGP fingerprint (40 hexadecimal characters)",
			"type": "string",
			"pattern": "^[0-9A-E]{40}$"
		    },
		    "default": []
		},
		"packages": {
		    "description": "Specifiers of packages that should be used, can include version constraints",
		    "type": "array",
		    "items": {
			"description": "A package specifier like \"libjs-jquery=3.3.1~dfsg-3\"",
			"type": "string"
		    },
		    "minItems": 1
		},
		"dependencies": {
		    "description": "Boolean indicating whether dependent APT packages should also be downloaded and used",
		    "type": "boolean"
		},
		"depend_on_base_packages": {
		    "description": "Boolean indicating whether the resulting resource packages should depend on 'apt-common-licenses' Haketilo package",
		    "type": "boolean",
		    "default": true
		}
	    }
	},
	"item_definition": {
	    "description": "Definition of either a site resource, a pattern->payload mapping or both combined together",
	    "if": {
		"type": "object",
		"required": ["type"],
		"properties": {
		    "type": {
			"const": "resource"
		    }
		}
	    },
	    "then": {
		"$ref": "./common_definitions-2.schema.json#/definitions/resource_definition_base"
	    },
	    "else": {
		"if": {
		    "type": "object",
		    "required": ["type"],
		    "properties": {
			"type": {
			    "const": "mapping"
			}
		    }
		},
		"then": {
		    "$ref": "./common_definitions-2.schema.json#/definitions/mapping_definition_base"
		},
		"else": {
		    "allOf": [{
			"type": "object",
			"required": ["type"],
			"properties": {
			    "type": {
				"const": "mapping_and_resource"
			    }
			}
		    }, {
			"$ref": "#/definitions/combined_mapping_resource_definition"
		    }]
		}
	    }
	},
	"combined_mapping_resource_definition": {
	    "allOf": [{
		"$ref": "./common_definitions-2.schema.json#/definitions/mapping_definition_base"
	    }, {
		"$ref": "./common_definitions-2.schema.json#/definitions/resource_definition_base"
	    }]
	}
    }
}