@nx/js:release-version
DO NOT INVOKE DIRECTLY WITH nx generate. Use nx release version instead.
Schema for internal use only
Please do not extend this schema as it is part of Nx internal usage.
Usage
1nx generate release-version ...
2By default, Nx will search for release-version in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
1nx g @nx/js:release-version ...
2Show what will be generated without writing to disk:
1nx g release-version ... --dry-run
2Options
projects
Required
Array<object: object>
The ProjectGraphProjectNodes being versioned in the current execution.
projectGraph
Required
object: object
ProjectGraph instance
releaseGroup
Required
object: object
The resolved release group configuration, including name, relevant to all projects in the current execution.
currentVersionResolver
string
Default:
diskAccepted values:
registry, disk, git-tagWhich approach to use to determine the current version of the project.
currentVersionResolverMetadata
object: object
Default:
{}Additional metadata to pass to the current version resolver.
installArgs
string
Additional arguments to pass to the package manager when updating the lock file with an install command.
installIgnoreScripts
boolean
Whether to ignore install lifecycle scripts when updating the lock file with an install command.
preid
string
The optional prerelease identifier to apply to the version, in the case that the specifier argument has been set to prerelease.
packageRoot
string
The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root
specifier
string
Exact version or semver keyword to apply to the selected release group. Overrides specifierSource.
specifierSource
string
Default:
promptAccepted values:
prompt, conventional-commits, version-plansWhich approach to use to determine the semver specifier used to bump the version of the project.
skipLockFileUpdate
boolean
Whether to skip updating the lock file after updating the version.