forked from dotnet/Nerdbank.GitVersioning
/
version.schema.json
202 lines (202 loc) · 9.1 KB
/
version.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
{
"$schema": "http://json-schema.org/draft-04/schema",
"title": "Nerdbank.GitVersioning version.json schema",
"type": "object",
"anyOf": [
{ "$ref": "#/definitions/baseFile" },
{ "$ref": "#/definitions/inheritingFile" }
],
"definitions": {
"baseFile": {
"allOf": [
{ "$ref": "#/definitions/allProperties" },
{ "required": [ "version" ] }
]
},
"inheritingFile": {
"allOf": [
{ "$ref": "#/definitions/allProperties" },
{ "required": [ "inherit" ] },
{
"properties": {
"inherit": {
"enum": [ true ]
}
}
}
]
},
"allProperties": {
"properties": {
"version": {
"type": "string",
"description": "The major.minor-pre version to use as the basis for version calculations. If {height} is not used in this value and the value has fewer than the full major.minor.build.revision specified, \".{height}\" will be appended by the build.",
"pattern": "^v?(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:\\.(0|[1-9][0-9]*)(?:\\.(0|[1-9][0-9]*))?)?(-(?:[\\da-z\\-]+|\\{height\\})(?:\\.(?:[\\da-z\\-]+|\\{height\\}))*)?(\\+(?:[\\da-z\\-]+|\\{height\\})(?:\\.(?:[\\da-z\\-]+|\\{height\\}))*)?$"
},
"inherit": {
"type": "boolean",
"description": "A value indicating whether this file only partially describes the versioning policy, and that more information should be discovered in an ancestor directory.",
"default": false
},
"assemblyVersion": {
"description": "The x.y version to use particularly for the AssemblyVersionAttribute instead of the default. This is useful when maintaining assembly binding compatibility on the desktop .NET Framework is important even though AssemblyFileVersion may change.",
"oneOf": [
{ "$ref": "#/definitions/majorMinorVersion" },
{
"type": "object",
"properties": {
"version": { "$ref": "#/definitions/majorMinorVersion" },
"precision": {
"type": "string",
"description": "Identifies the last component to be explicitly set in the version.",
"enum": [ "major", "minor", "build", "revision" ],
"default": "minor"
}
}
}
]
},
"versionHeightOffset": {
"type": "integer",
"description": "A number to add to the git height when calculating the version height (which typically appears as the 3rd integer in a computed version). May be negative, but not of greater magnitude than the original git height.",
"default": 0
},
"buildNumberOffset": {
"type": "integer",
"description": "OBSOLETE by v3.0. Use \"versionHeightOffset\" instead. A number to add to the git height when calculating the version height (which typically appears as the 3rd integer in a computed version). May be negative, but not of greater magnitude than the original git height.",
"default": 0
},
"semVer1NumericIdentifierPadding": {
"type": "integer",
"description": "The minimum number of digits to use for numeric identifiers in SemVer 1.",
"default": 4,
"minimum": 1,
"maximum": 6
},
"gitCommitIdShortFixedLength": {
"type": "integer",
"description": "The fixed number of characters to use for the commit ID abbreviation length. This property is ignored if the gitCommitIdShortAutoMinimum property is greater than 0.",
"default": 10,
"maximum": 40
},
"gitCommitIdPrefix": {
"type": "string",
"description": "The git commit prefix (e.g. 'g') in non-public release versions.",
"pattern": "^[^0-9][\\da-z\\-_\\.]*$",
"default": "g"
},
"gitCommitIdShortAutoMinimum": {
"type": "integer",
"description": "When greater than 0, the length of the commit ID will be either this value or the shortest unambiguous git-abbreviated commit ID possible, whichever is greater. When 0, the gitCommitIdShortFixedLength property is used instead.",
"default": 0,
"maximum": 40
},
"nugetPackageVersion": {
"type": "object",
"description": "Details for how and what the generated version for NuGet packages will be.",
"properties": {
"semVer": {
"type": "integer",
"description": "The version of SemVer (e.g. 1 or 2) that should be used when generating the package version.",
"default": 1,
"minimum": 1,
"maximum": 2
}
}
},
"publicReleaseRefSpec": {
"type": "array",
"description": "An array of regular expressions that may match a ref (branch or tag) that should be built with PublicRelease=true as the default value. The ref matched against is in its canonical form (e.g. refs/heads/master)",
"items": {
"type": "string",
"format": "regex"
},
"uniqueItems": true
},
"cloudBuild": {
"type": "object",
"description": "Options that are applicable specifically to cloud builds (e.g. VSTS, AppVeyor, TeamCity)",
"properties": {
"setAllVariables": {
"type": "boolean",
"default": false,
"description": "Elevates all build properties to cloud build variables prefaced with \"NBGV_\""
},
"setVersionVariables": {
"type": "boolean",
"default": true,
"description": "Elevate certain calculated version build properties to cloud build variables."
},
"buildNumber": {
"type": "object",
"description": "Override the build number preset by the cloud build with one enriched with version information.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to override the build number preset by the cloud build.",
"default": false
},
"includeCommitId": {
"type": "object",
"description": "Describes when and where to include information about the git commit being built.",
"properties": {
"when": {
"type": "string",
"default": "nonPublicReleaseOnly",
"description": "The conditions when the commit ID is included in the build number.",
"enum": [ "always", "nonPublicReleaseOnly", "never" ]
},
"where": {
"type": "string",
"default": "buildMetadata",
"description": "The position to include the commit ID information.",
"enum": [ "buildMetadata", "fourthVersionComponent" ]
}
}
}
}
}
}
},
"release": {
"description": "Settings for the prepare-release command",
"type": "object",
"properties": {
"branchName": {
"description": "Defines the format of release branch names. Format must include a placeholder '{version}' for the version",
"type": "string",
"pattern": ".*\\{version\\}.*",
"default": "v{version}"
},
"versionIncrement": {
"description": "Specifies which part of the version on the current branch is incremented when preparing a release.",
"type": "string",
"enum": [ "major", "minor", "build" ],
"default": "minor"
},
"firstUnstableTag": {
"description": "Specifies the first/default prerelease tag for new versions",
"type": "string",
"default": "alpha"
}
},
"additionalProperties": false
},
"pathFilters": {
"type": "array",
"description": "An array of pathspec-like strings that are used to filter commits when calculating the version height. A commit will not increment the version height if its changed files are not included by these filters.\nPaths are relative to this file. Paths relative to the root of the repository can be specified with the `:/` prefix.\nExclusions can be specified with a `:^` prefix for relative paths, or a `:^/` prefix for paths relative to the root of the repository.\nAfter a path matches any non-exclude filter, it will be run through all exclude filters. If it matches, the path is ignored.",
"items": {
"type": "string",
"pattern": "^(:\\^|:!|:/|[^:])"
},
"uniqueItems": true
}
}
},
"majorMinorVersion": {
"type": "string",
"description": "A major.minor version",
"pattern": "^\\d+\\.\\d+$"
}
}
}