Schema for internal use only

Please do not extend this schema as it is part of Nx internal usage.

@nx/js:release-version

DO NOT INVOKE DIRECTLY WITH nx generate. Use nx release version instead.

Usage

1nx generate release-version ... 2

By 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 ... 2
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

1nx g release-version ... --dry-run 2

Options

projects

Required
Array<object: object>

The ProjectGraphProjectNodes being versioned in the current execution.

projectGraph

Required
object: object

ProjectGraph instance

specifier

Required
string

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.

currentVersionResolver

string
Default: disk
Accepted values: registry, disk

Which approach to use to determine the current version of the project.

currentVersionResolverMetadata

object: object
Default: {}

Additional metadata to pass to the current version resolver.

preid

string

The optional prerelease identifier to apply to the version, in the case that specifier 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