Skip to content

[vcpkg] Add versioning fields to schema #14947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BillyONeal merged 1 commit into from
Dec 6, 2020
Merged

[vcpkg] Add versioning fields to schema #14947

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 180 additions & 76 deletions scripts/vcpkg.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,69 @@
}
]
},
"version-text": {
"type": "string",
"pattern": "[^#]+"
},
"has-schemed-version": {
"type": "object",
"oneOf": [
{
"properties": {
"version-string": {
"description": "Text used to identify an arbitrary version",
"type": "string",
"pattern": "^[^#]+$"
}
},
"required": [
"version-string"
]
},
{
"properties": {
"version": {
"description": "A relaxed version string (1.2.3.4...)",
"type": "string",
"pattern": "^\\d+(\\.\\d+)*$"
}
},
"required": [
"version"
]
},
{
"properties": {
"version-semver": {
"description": "A semantic version string. See https://semver.org/",
"type": "string",
"pattern": "^\\d+\\.\\d+\\.\\d+([+-].+)?$"
}
},
"required": [
"version-semver"
]
},
{
"properties": {
"version-date": {
"description": "A date version string (e.g. 2020-01-20)",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(\\.\\d+)*$"
}
},
"required": [
"version-date"
]
}
]
},
"port-version": {
"description": "A non-negative integer indicating the port revision. If this field doesn't exist, it's assumed to be `0`.",
"type": "integer",
"minimum": 0,
"default": 0
},
"package-name": {
"description": "Name of a package.",
"allOf": [
Expand Down Expand Up @@ -71,6 +134,14 @@
},
"platform": {
"$ref": "#/definitions/platform-expression"
},
"version>=": {
"description": "Minimum required port version",
"$ref": "#/definitions/version-text"
},
"port-version": {
"description": "Minimum port revision (defaults to 0)",
"$ref": "#/definitions/port-version"
}
},
"patternProperties": {
Expand All @@ -92,6 +163,28 @@
}
]
},
"override": {
"description": "A version override.",
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/identifier"
},
"version": {
"$ref": "#/definitions/version-text"
},
"port-version": {
"$ref": "#/definitions/port-version"
}
},
"patternProperties": {
"^\\$": {}
},
"required": [
"name",
"version"
]
},
"platform-expression": {
"description": "A specification of a set of platforms. See https://github.com/microsoft/vcpkg/blob/master/docs/specifications/manifests.md#definitions.",
"type": "string"
Expand Down Expand Up @@ -125,82 +218,93 @@
}
},
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/package-name"
},
"version-string": {
"description": "A string without semantic meaning, equivalent to `CONTROL`'s `Version` field.",
"type": "string"
},
"port-version": {
"description": "A non-negative integer. If this field doesn't exist, it's assumed to be `0`.",
"type": "integer",
"minimum": 0,
"default": 0
},
"maintainers": {
"description": "An array of strings which contain the authors of a package",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"$ref": "#/definitions/description-field"
},
"homepage": {
"description": "A url which points to the homepage of a package.",
"type": "string",
"format": "uri"
},
"documentation": {
"description": "A url which points to the documentation of a package.",
"type": "string",
"format": "uri"
},
"license": {
"description": "An SPDX license expression at version 3.9.",
"type": "string"
},
"dependencies": {
"description": "Dependencies that are always required.",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
},
"dev-dependencies": {
"description": "Dependencies only required for developers (testing and the like).",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
},
"features": {
"description": "An array of features supported by the package",
"type": "array",
"items": {
"$ref": "#/definitions/feature"
}
},
"default-features": {
"description": "Features enabled by default with the package.",
"type": "array",
"items": {
"$ref": "#/definitions/identifier"
}
"allOf": [
{
"properties": {
"name": {
"description": "The name of the top-level package",
"$ref": "#/definitions/package-name"
},
"version-string": {},
"version": {},
"version-date": {},
"version-semver": {},
"port-version": {
"$ref": "#/definitions/port-version"
},
"maintainers": {
"description": "An array of strings which contain the authors of a package",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"$ref": "#/definitions/description-field"
},
"homepage": {
"description": "A url which points to the homepage of a package.",
"type": "string",
"format": "uri"
},
"documentation": {
"description": "A url which points to the documentation of a package.",
"type": "string",
"format": "uri"
},
"license": {
"description": "An SPDX license expression at version 3.9.",
"type": "string"
},
"dependencies": {
"description": "Dependencies that are always required.",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
},
"overrides": {
"description": "Version overrides for dependencies.",
"type": "array",
"items": {
"$ref": "#/definitions/override"
}
},
"dev-dependencies": {
"description": "Dependencies only required for developers (testing and the like).",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
},
"features": {
"description": "An array of features supported by the package",
"type": "array",
"items": {
"$ref": "#/definitions/feature"
}
},
"default-features": {
"description": "Features enabled by default with the package.",
"type": "array",
"items": {
"$ref": "#/definitions/identifier"
}
},
"supports": {
"$ref": "#/definitions/platform-expression"
}
},
"patternProperties": {
"^\\$": {}
},
"required": [
"name"
],
"additionalProperties": false
},
"supports": {
"$ref": "#/definitions/platform-expression"
{
"$ref": "#/definitions/has-schemed-version"
}
},
"patternProperties": {
"^\\$": {}
},
"required": [
"name",
"version-string"
],
"additionalProperties": false
]
}