Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VersionApplyCommand

Hierarchy

Properties

all

all: boolean = Option.Boolean(`--all`, false, {description: `Apply the deferred version changes on all workspaces`,})

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

dryRun

dryRun: boolean = Option.Boolean(`--dry-run`, false, {description: `Print the versions without actually generating the package archive`,})

json

json: boolean = Option.Boolean(`--json`, false, {description: `Format the output as an NDJSON stream`,})

prerelease

prerelease: undefined | string | false | true = Option.String(`--prerelease`, {description: `Add a prerelease identifier to new versions`,tolerateBoolean: true,})

recursive

recursive: undefined | false | true = Option.Boolean(`-R,--recursive`, {description: `Release the transitive workspaces as well`,})

Static paths

paths: string[][] = [[`version`, `apply`],]

Static usage

usage: Usage = Command.Usage({category: `Release-related commands`,description: `apply all the deferred version bumps at once`,details: `This command will apply the deferred version changes and remove their definitions from the repository.Note that if \`--prerelease\` is set, the given prerelease identifier (by default \`rc.%d\`) will be used on all new versions and the version definitions will be kept as-is.By default only the current workspace will be bumped, but you can configure this behavior by using one of:- \`--recursive\` to also apply the version bump on its dependencies- \`--all\` to apply the version bump on all packages in the repositoryNote that this command will also update the \`workspace:\` references across all your local workspaces, thus ensuring that they keep referring to the same workspaces even after the version bump.`,examples: [[`Apply the version change to the local workspace`,`yarn version apply`,], [`Apply the version change to all the workspaces in the local workspace`,`yarn version apply --all`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc