nx/docs/generated/packages/js/generators/release-version.json
James Henry 9116c29c18
feat(core): initial implementation of nx release (#19110)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-09-18 15:11:44 -04:00

55 lines
2.1 KiB
JSON

{
"name": "release-version",
"factory": "./src/generators/release-version/release-version#releaseVersionGenerator",
"schema": {
"$schema": "http://json-schema.org/schema",
"$id": "NxJSReleaseVersionGenerator",
"cli": "nx",
"title": "Implementation details of `nx release version`",
"description": "DO NOT INVOKE DIRECTLY WITH `nx generate`. Use `nx release version` instead.",
"type": "object",
"properties": {
"projects": {
"type": "array",
"description": "The ProjectGraphProjectNodes being versioned in the current execution.",
"items": { "type": "object" }
},
"projectGraph": {
"type": "object",
"description": "ProjectGraph instance"
},
"specifier": {
"type": "string",
"description": "Exact version or semver keyword to apply to the selected release group. NOTE: This should be set on the release group level, not the project level."
},
"preid": {
"type": "string",
"description": "The optional prerelease identifier to apply to the version, in the case that specifier has been set to prerelease."
},
"packageRoot": {
"type": "string",
"description": "The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root"
},
"currentVersionResolver": {
"type": "string",
"default": "disk",
"description": "Which approach to use to determine the current version of the project.",
"enum": ["registry", "disk"]
},
"currentVersionResolverMetadata": {
"type": "object",
"description": "Additional metadata to pass to the current version resolver.",
"default": {}
}
},
"required": ["projects", "projectGraph", "specifier"],
"presets": []
},
"description": "DO NOT INVOKE DIRECTLY WITH `nx generate`. Use `nx release version` instead.",
"hidden": true,
"implementation": "/packages/js/src/generators/release-version/release-version#releaseVersionGenerator.ts",
"aliases": [],
"path": "/packages/js/src/generators/release-version/schema.json",
"type": "generator"
}