@nx/jsSee schema
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

Show what will be generated without writing to disk:

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

Options

projects

RequiredHidden
Array<object: object>

The ProjectGraphProjectNodes being versioned in the current execution.

projectGraph

RequiredHidden
object: object

ProjectGraph instance

releaseGroup

RequiredHidden
object: object

The resolved release group configuration, including name, relevant to all projects in the current execution.

conventionalCommitsConfig

Hidden
object: object
Default: {}

The conventional commits configuration to use when determining the next version of the project.

currentVersionResolver

string
Default: disk
Accepted values: registry, disk, git-tag

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.

firstRelease

Hidden
boolean

Whether this is the first release of the project (which skips some validation within the generator).

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: prompt
Accepted values: prompt, conventional-commits, version-plans

Which 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.