npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

@yoitsro/lerna-version

3.5.1 • Public • Published

@lerna/version

Bump version of packages changed since the last release

Usage

lerna version 1.0.1 # explicit 
lerna version patch # semver keyword 
lerna version       # select from prompt(s) 

When run, this command does the following:

  1. Identifies packages that have been updated since the previous tagged release.
  2. Prompts for a new version.
  3. Modifies package metadata to reflect new release.
  4. Commits those changes and tags the commit.
  5. Pushes to the git remote.

Positionals

semver bump

lerna version [major | minor | patch | premajor | preminor | prepatch | prerelease]
# uses the next semantic version(s) value and this skips `Select a new version for...` prompt 

When run with this flag, lerna version will skip the version selection prompt and increment the version by that keyword. You must still use the --yes flag to avoid all prompts.

"Graduating" prereleases

If you have any packages with a prerelease version number (e.g. 2.0.0-beta.3) and you run lerna version with and a non-prerelease bump (major, minor, or patch), it will publish those previously pre-released packages as well as the packages that have changed since the last release.

Options

--allow-branch <glob>

A whitelist of globs that match git branches where lerna version is enabled. It is easiest (and recommended) to configure in lerna.json, but it is possible to pass as a CLI option as well.

{
  "command": {
    "publish": {
      "allowBranch": "master"
    }
  }
}

With the configuration above, the lerna version will fail when run from any branch other than master. It is considered a best-practice to limit lerna version to the primary branch alone.

{
  "command": {
    "publish": {
      "allowBranch": ["master", "feature/*"]
    }
  }
}

With the preceding configuration, lerna version will be allowed in any branch prefixed with feature/. Please be aware that generating git tags in feature branches is fraught with potential errors as the branches are merged into the primary branch. If the tags are "detached" from their original context (perhaps through a squash merge or a conflicted merge commit), future lerna version executions will have difficulty determining the correct "diff since last release."

It is always possible to override this "durable" config on the command-line. Please use with caution.

lerna version --allow-branch hotfix/oops-fix-the-thing

--amend

lerna version --amend
# commit message is retained, and `git push` is skipped. 

When run with this flag, lerna version will perform all changes on the current commit, instead of adding a new one. This is useful during Continuous integration (CI) to reduce the number of commits in the project's history.

In order to prevent unintended overwrites, this command will skip git push (i.e., it implies --no-push).

--commit-hooks

Run git commit hooks when committing the version changes.

Defaults to true. Pass --no-commit-hooks to disable.

This option is analogous to the npm version option of the same name.

--conventional-commits

lerna version --conventional-commits

When run with this flag, lerna version will use the Conventional Commits Specification to determine the version bump and generate CHANGELOG

--changelog-preset

lerna version --conventional-commits --changelog-preset angular-bitbucket

By default, the changelog preset is set to angular. In some cases you might want to change either use a another preset or a custom one.

Presets are names of built-in or installable configuration for conventional changelog. Presets may be passed as the full name of the package, or the auto-expanded suffix (e.g., angular is expanded to conventional-changelog-angular).

--exact

lerna version --exact

When run with this flag, lerna version will specify updated dependencies in updated packages exactly (with no punctuation), instead of as semver compatible (with a ^).

For more information, see the package.json dependencies documentation.

--force-publish

lerna version --force-publish=package-2,package-4
 
# force all packages to be versioned 
lerna version --force-publish

When run with this flag, lerna version will force publish the specified packages (comma-separated) or all packages using *.

This will skip the lerna changed check for changed packages and forces a package that didn't have a git diff change to be updated.

--ignore-changes

Ignore changes in files matched by glob(s) when detecting changed packages.

lerna version --ignore-changes '**/*.md' '**/__tests__/**'

This option is best specified as root lerna.json configuration, both to avoid premature shell evaluation of the globs and to share the config with lerna diff and lerna changed:

{
  "ignoreChanges": [
    "**/__fixtures__/**",
    "**/__tests__/**",
    "**/*.md"
  ]
}

Pass --no-ignore-changes to disable any existing durable configuration.

--git-remote <name>

lerna version --git-remote upstream

When run with this flag, lerna version will push the git changes to the specified remote instead of origin.

--git-tag-version

Commit and tag versioned changes.

Defaults to true. Pass --no-git-tag-version to disable.

This option is analogous to the npm version option of the same name.

--message <msg>

This option is aliased to -m for parity with git commit.

lerna version -m "chore(release): publish %s"
# commit message = "chore(release): publish v1.0.0" 
 
lerna version -m "chore(release): publish %v"
# commit message = "chore(release): publish 1.0.0" 
 
# When versioning packages independently, no placeholders are replaced 
lerna version -m "chore(release): publish"
# commit message = "chore(release): publish 
# 
# - package-1@3.0.1 
# - package-2@1.5.4" 

When run with this flag, lerna version will use the provided message when committing the version updates for publication. Useful for integrating lerna into projects that expect commit messages to adhere to certain guidelines, such as projects which use commitizen and/or semantic-release.

If the message contains %s, it will be replaced with the new global version version number prefixed with a "v". If the message contains %v, it will be replaced with the new global version version number without the leading "v". Note that this only applies when using the default "fixed" versioning mode, as there is no "global" version when versioning independently.

This can be configured in lerna.json, as well:

{
  "command": {
    "publish": {
      "message": "chore(release): publish %s"
    }
  }
}

--preid

lerna version prerelease
# uses the next semantic prerelease version, e.g. 
# 1.0.0 => 1.0.1-alpha.0 
 
lerna version prepatch --preid next
# uses the next semantic prerelease version with a specific prerelease identifier, e.g. 
# 1.0.0 => 1.0.1-next.0 

When run with this flag, lerna version will increment premajor, preminor, prepatch, or prerelease semver bumps using the specified prerelease identifier.

--push

Push the committed and tagged changes to the configured git remote

--sign-git-commit

This option is analogous to the npm version option of the same name.

--sign-git-tag

This option is analogous to the npm version option of the same name.

--yes

lerna version --yes
# skips `Are you sure you want to publish these packages?` 

When run with this flag, lerna version will skip all confirmation prompts. Useful in Continuous integration (CI) to automatically answer the publish confirmation prompt.

Deprecated Options

--cd-version

Pass the semver keyword to the bump positional instead.

--repo-version

Pass an explicit version number to the bump positional instead.

--skip-git

Use --no-git-tag-version and --no-push instead.

NOTE: This option does not restrict all git commands from being executed. git is still required by lerna version.

Keywords

install

npm i @yoitsro/lerna-version

Downloadsweekly downloads

4

version

3.5.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability