-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
changelogging.schema.json
190 lines (190 loc) · 6.04 KB
/
changelogging.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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"Context": {
"title": "Context",
"description": "Represents contexts of projects.",
"type": "object",
"required": [
"name",
"version",
"url"
],
"properties": {
"name": {
"description": "The name of the project.",
"$ref": "#/$defs/NonEmptyString"
},
"version": {
"description": "The version of the project.",
"$ref": "#/$defs/NonEmptyString"
},
"url": {
"description": "The URL of the project.",
"$ref": "#/$defs/NonEmptyString"
}
},
"additionalProperties": false
},
"Paths": {
"title": "Paths",
"description": "Specifies locations of fragments and the changelog.",
"type": "object",
"properties": {
"directory": {
"description": "The directory containing fragments.",
"$ref": "#/$defs/NonEmptyString",
"default": "changes"
},
"output": {
"description": "The file containing the changelog.",
"$ref": "#/$defs/NonEmptyString",
"default": "CHANGELOG.md"
}
},
"additionalProperties": false
},
"NonEmptyString": {
"type": "string",
"minLength": 1
},
"Start": {
"description": "Marks the location in the changelog to start writing entries after.",
"$ref": "#/$defs/NonEmptyString"
},
"Level": {
"type": "integer",
"minimum": 1
},
"Levels": {
"title": "Levels",
"description": "Defines which heading levels to use.",
"type": "object",
"properties": {
"entry": {
"description": "The heading level of the entry title.",
"$ref": "#/$defs/Level",
"default": 2
},
"section": {
"description": "The heading level of individual sections.",
"$ref": "#/$defs/Level",
"default": 3
}
},
"additionalProperties": false
},
"Character": {
"type": "string",
"minLength": 1,
"maxLength": 1
},
"Indents": {
"title": "Indents",
"description": "Specifies which characters to use for indenting.",
"type": "object",
"properties": {
"heading": {
"description": "The character to use for headings.",
"$ref": "#/$defs/Character",
"default": "#"
},
"bullet": {
"description": "The character to use for indenting.",
"$ref": "#/$defs/Character",
"default": "-"
}
},
"additionalProperties": false
},
"Formats": {
"title": "Formats",
"description": "Defines formats to use for rendering entry titles and fragments.",
"type": "object",
"properties": {
"title": {
"description": "The format used for rendering entry titles.",
"$ref": "#/$defs/NonEmptyString",
"default": "{{version}} ({{date}})"
},
"fragment": {
"description": "The format used for rendering fragments.",
"$ref": "#/$defs/NonEmptyString",
"default": "{{content}} (#{{id}})"
}
},
"additionalProperties": false
},
"Wrap": {
"type": "integer",
"minimum": 1
},
"Order": {
"description": "Defines which types to include, and in what order.",
"type": "array",
"items": {
"description": "The type to include.",
"$ref": "#/$defs/NonEmptyString"
}
},
"Types": {
"title": "Types",
"description": "Maps types to their titles.",
"type": "object",
"patternProperties": {
"^.+$": {
"$ref": "#/$defs/NonEmptyString"
}
},
"additionalProperties": false
}
},
"title": "changelogging",
"description": "changelogging configuration file.",
"type": "object",
"required": [
"context"
],
"properties": {
"context": {
"$ref": "#/$defs/Context"
},
"paths": {
"$ref": "#/$defs/Paths"
},
"start": {
"$ref": "#/$defs/Start",
"default": "<!-- changelogging: start -->"
},
"levels": {
"$ref": "#/$defs/Levels"
},
"indents": {
"$ref": "#/$defs/Indents"
},
"formats": {
"$ref": "#/$defs/Formats"
},
"wrap": {
"$ref": "#/$defs/Wrap",
"default": 100
},
"order": {
"$ref": "#/$defs/Order",
"default": ["security", "feature", "change", "fix", "deprecation", "removal", "internal"]
},
"types": {
"$ref": "#/$defs/Types",
"default": {
"security": "Security",
"feature": "Features",
"change": "Changes",
"fix": "Fixes",
"deprecation": "Deprecations",
"removal": "Removals",
"internal": "Internal"
}
}
},
"additionalProperties": false
}