Bump version & write changelog of packages changed since the last release
npm install @lerna-lite/version
lerna version) - Version command [optional] 📑Lerna-Lite Version command, bump version of packages changed since the last release.
---
``sh
npm install @lerna-lite/version -D
> Note please make sure that you have a
config file and a version property defined with either a fixed or independent mode (for example: "version": "independent"). An error will be thrown if you're missing any of them.Usage
`sh
lerna version 1.0.1 # explicit
lerna version patch # semver keyword
lerna version # select from prompt(s)
pnpm exec lerna version # select from prompt(s) using pnpm
`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, running appropriate lifecycle scripts in root and per-package.
4. Commits those changes and tags the commit.
5. Pushes to the git remote.
Positionals
$3
sh
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 this positional parameter is passed,
will skip the version selection prompt and increment the version by that keyword.
You must still use the --yes flag to avoid all prompts.Prerelease
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.For projects using conventional commits, use the following flags for prerelease management:
--conventional-prerelease: release current changes as prerelease versions.
- --conventional-graduate: graduate prerelease versioned packages to stable versions.Running
lerna version --conventional-commits without the above flags will release current changes as prerelease only if the version is already in prerelease.Options
lerna version accepts all filter flags.`sh
$ lerna version --scope my-component test
`
- Usage
- Positionals
- semver
- Prerelease
- Options
-
-
-
-
- Comments on resolved issues/pull requests
- [](#--comment-issue-msg)
- [--comment-pull-request [msg]](#--comment-pull-request-msg)
- --changelog-preset
-
-
-
-
-
- [](#--changelog-include-commits-git-author-msg)
- [--changelog-include-commits-client-login [msg]](#--changelog-include-commits-client-login-msg)
- --changelog-header-message
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Tips
- Generating Initial Changelogs
- Lifecycle Scripts
- protocol
- workspace: protocol$3
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.`json
{
"command": {
"version": {
"allowBranch": "main"
}
}
}
`With the configuration above, the
will fail when run from any branch other than main.
It is considered a best-practice to limit lerna version to the primary branch alone.`json
{
"command": {
"version": {
"allowBranch": ["main", "feature/*"]
}
}
}
`With the preceding configuration,
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.
`sh
lerna version --allow-branch hotfix/oops-fix-the-thing
`$3
sh
lerna version --allow-peer-dependencies-update
`By default peer dependencies versions will not be bumped unless this flag is enabled. When the package to be bumped is found in regular
(or devDependencies) and also in peerDependencies, then it will bump both of them to the same version.> Note peer dependency that includes a semver range with an operator (ie
>=2.0.0) will never be mutated even if this flag is enabled.> Note peer dependencies that use
workspace: protocol will be bump even without enabling --allow-peer-dependencies-update because that protocol always expect a version replacement with current version.> Note Please use with caution when enabling this option, it is not recommended for most users since the npm standard is to never mutate (bump) any
peerDependencies when publishing new version in an automated fashion, at least not without a user intervention, as explained by core Lerna maintainer:> > _Changes to a peer version range are always semver major, and should be as broad as possible._
> > _Until we can get fancier, we should never automatically modify them to match the new version being published (which is the current incorrect behavior)._
#### Examples
For the example shown below, we will consider the packages to have the following versions (
"A": "1.2.0", "B": "0.4.0", "C": 2.0.0"). The examples shown below includes very basic demo of what workspace: can do, for more info on that subject please read workspace: protocol.##### with flag enabled
with the new flag both deps would be updated and bumped, for example if we do a
minor bump
`js
{
"name": "B",
"dependencies": {
"A": "workspace:^1.2.0", // will bump the version to "workspace:^1.3.0" and publish as "^1.3.0"
"B": "^0.4.0", // will bump to "^0.5.0"
"C": "workspace:^" // will bump the version to "workspace:^2.1.0" and publish as "^2.1.0"
},
"peerDependencies": {
"D": "workspace:^1.2.0", // will update the version to "workspace:^1.3.0" and publish as "^1.3.0"
"E": ">=0.2.0", // will not be updated because range with operator (>=) are skipped
"F": "workspace:^" // will keep the version to "workspace:^" but publish as "^2.1.0"
}
}
`##### without flag
without the flag peer dependencies are completely ignored except for
which are always bumped even without the flag and the reason is because workspace: are always expected to be transformed.`js
{
"name": "B",
"dependencies": {
"A": "workspace:^1.2.0", // will bump to "workspace:^1.3.0"
"B": "^0.4.0", // will bump to "^0.5.0"
"C": "workspace:^"
},
"peerDependencies": {
"D": "workspace:^1.2.0", // will update the version to "workspace:^1.3.0" and publish as "^1.3.0"
"E": ">=0.2.0", // will NOT bump the version and will publish as ">=0.2.0"
"F": "workspace:^", // will keep the version to "workspace:^" but publish as "^2.1.0"
"G": "^1.2.0" // will NOT bump because the flag is disabled and workspace: was not found
}
}
`#### Some Exclusions
with the flag enabled, it will update regular semver like these
-
-
-
- but it will never update or change versions with ranges
-
-
- $3
sh
lerna version --amend
commit message is retained, and
git push is skipped.
`When run with this flag,
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).$3
`sh
lerna version --build-metadata 001
`Build metadata must be SemVer compatible. When provided it will apply to all updated packages, irrespective of whether independent or fixed versioning is utilised. If prompted to choose package version bumps, you can request a custom version to alter or remove build metadata for specific packages.
$3
When enabled, it will insert comments on all the closed linked issues and/or merged pull requests that were included in the release (currently only GitHub is supported). You could also provide a custom format by using any of these tokens (
, %v, %u), see examples below.-
%s: git tag - (e.g. "v1.0.2")
- %v: version number only - (e.g. "1.0.2")
- %u: release URL - (e.g. "https://github.com/lerna-lite/lerna-lite/releases/tag/v4.11.0")When running in a GitHub CI environment, you will also need the following permissions (and a valid GitHub token):
`yaml
permissions:
contents: write # to be able to publish a GitHub release
id-token: write # to enable use of OIDC for npm provenance
issues: write # to be able to comment on released issues
pull-requests: write # to be able to comment on released pull requests
`> [!NOTE]
> GitHub is the only supported client at the moment and you must provide 1 of these 2 options
or --remote-client . Also note that it will only fetch a maximum of 100 issues/PRs (max handled by octokit API) and I think that is more than enough.> [!NOTE]
> This feature works best with a single global version and might not work as expected with
independent mode, there is just no easy ways to detect which issues/PRs belongs to which package. You could still use it with independent but none of the tokens shown above will be available (or at least won't provide the correct info) and so in that case using a generic message is the only suggestion we have (e.g.: "This PR is included in latest release").#####
--comment-issue [msg]Insert Comments on all the closed issues that were included in the release. The issues could be linked to PRs (when issue is referenced in PR body) or could also be found in the PR title/subject (like
, or "fixes #123" or "closes #123", ...)`sh
enable it and use default template
lerna publish --comment-issue
you could also provide a custom message
lerna publish --comment-issue "This issue has been resolved in %s."
`> The default message is:
#####
Insert Comments on all the merged Pull Requests that were included in the release. You can customize the message and also the PR keywords to search for (the default are "fix,feat,perf", it must be a CSV string and it will search as "Starts With [keywords]")
sh
enable it and use default template
lerna publish --comment-pull-request
you could also provide a custom message
lerna publish --comment-pull-request "This pull request is included in %s."
you can configure the PR search keywords as CSV, defaults to "fix,feat,perf"
lerna publish --comment-pull-request "This pull request is included in %s." --comment-filter-keywords "fix,feat"
`> The default message is:
$3
sh
lerna version --conventional-commits --changelog-preset angular-bitbucket
`.
In some cases you might want to change either use 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).This option can also be specified in
lerna.json configuration:`json
{
"changelogPreset": "angular"
}
`If the preset exports a builder function (e.g.
), you can specify the preset configuration too:`json
{
"changelogPreset": {
"name": "conventionalcommits",
"issueUrlFormat": "{{host}}/{{owner}}/{{repository}}/issues/{{id}}"
}
}
`> Note the option
is not supported and will throw, you can simply use --message to have the same result.
If you use any preset other than the default, you should also install the matching
conventional-changelog package as a devDependency.
The value of this argument will also be used to determine the version bump for each package if the --conventional-commits flag is passed.Below is a full demo of how you can use a preset with full configuration
`json
{
"$schema": "node_modules/@lerna-lite/cli/schemas/lerna-schema.json",
"version": "1.0.0",
"changelogPreset": {
"name": "conventionalcommits",
"issueUrlFormat": "{{host}}/{{owner}}/{{repository}}/issues/{{id}}",
"types": [
{
"type": "feat",
"section": "✨ Features"
},
{
"type": "fix",
"section": "🐛 Bug Fixes"
},
{
"type": "perf",
"section": "🚀 Performance Improvements"
},
{
"type": "chore",
"hidden": true
},
{
"type": "docs",
"hidden": true
},
{
"type": "style",
"hidden": true
},
{
"type": "refactor",
"hidden": true
},
{
"type": "test",
"hidden": true
}
],
"issuePrefixes": ["#"],
"commitUrlFormat": "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}",
"compareUrlFormat": "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}",
"userUrlFormat": "{{host}}/{{user}}"
},
"packages": ["packages/*"]
}
`> [!WARNING]
> When using
with other tools for example @commitlint/config-conventional, you may need to override the version of the transitive conventional-changelog-conventionalcommits dependency, like so:
>
> `json
> {
> "overrides": {
> "conventional-changelog-conventionalcommits": "9.0.0"
> }
> }
> `
>
> Use for pnpm or Yarn.$3
`sh
lerna version --conventional-commits
`When run with this flag,
will use the Conventional Commits Specification to determine the version bump and generate CHANGELOG.md files.When run with this flag,
lerna version will use the conventional-changelog package to determine the version bump and generate CHANGELOG.md files.--changelog-preset option, lerna will use the default configuration from the conventional-changelog package, which is currently the angular spec.If you want your versions bumped according to a different spec, such as Conventional Commits Specification which supports the use of
! in the header to denote breaking changes, you must pass the --conventional-changelog flag with a spec name like conventionalcommits.--no-changelog will disable the generation (or updating) of CHANGELOG.md files.$3
`sh
lerna version --conventional-commits --conventional-graduate=package-2,package-4force all prerelease packages to be graduated
lerna version --conventional-commits --conventional-graduate
`When run with this flag,
will graduate the specified packages (comma-separated) or all packages using *. This command works regardless of whether the current HEAD has been released, similar to --force-publish, except that any non-prerelease packages are ignored. If changes are present for packages that are not specified (if specifying packages), or for packages that are not in prerelease, those packages will be versioned as they normally would using --conventional-commits."Graduating" a package means bumping to the non-prerelease variant of a prerelease version, eg.
package-1@1.0.0-alpha.0 => package-1@1.0.0.> Note when specifying packages, dependents of specified packages will be released, but will not be graduated.
$3
`sh
lerna version --conventional-commits --conventional-graduate=package-2,package-4 --force-conventional-graduateforce all prerelease packages to be graduated and updated if not a prerelease or having no change
lerna version --conventional-commits --conventional-graduate --force-conventional-graduate
`When run with this flag,
will graduate all packages specified by --conventional-graduate. Non-prerelease packages will not be ignored as it would be the case without the flag. In combination with single version mode this can be used to force all specified packages to be updated to a single version despite having no change or being a non-prerelease version. It works similar to --force-publish but is not ignored when --conventional-commits and --conventional-graduate are enabled. This flag is only applicable when having --conventional-graduate set, otherwise the option is ignored.$3
`sh
lerna version --conventional-commits --conventional-prerelease=package-2,package-4force all changed packages to be prereleased
lerna version --conventional-commits --conventional-prerelease
`When run with this flag,
will release with prerelease versions the specified packages (comma-separated) or all packages using *. Releases all unreleased changes as pre(patch/minor/major/release) by prefixing the version recommendation from conventional-commits with pre, eg. if present changes include a feature commit, the recommended bump will be minor, so this flag will result in a preminor release. If changes are present for packages that are not specified (if specifying packages), or for packages that are already in prerelease, those packages will be versioned as they normally would using --conventional-commits.$3
Specify if we want to include the git commit author's name to the end of each changelog commit entry and wrapped in (...). You could also provide a custom format by using any of these tokens (%a, %e), see examples below.
- %a: git author name, ie: ("Whitesource Renovate")
- %e: git author email, ie: ("bot@renovateapp.com")This option is only available when using
--conventional-commits with changelogs enabled.> Note the author name is what the user has configured in git, for more info please refer to Git Configuration. Also note, that is not the same as a remote client GitHub login username, Git does not store such information in its commit history, for that you will want to use the next option shown below.
`sh
default format, without any argument
will add the author name wrapped in (...) and appended to the commit line entry
lerna version --conventional-commits --changelog-include-commits-git-author
deps: update dependency git-url-parse to v12 (978bf36) (Whitesource Renovate)
custom format with 1 of these 2 tokens: %a and/or %e ##
lerna version --conventional-commits --changelog-include-commits-git-author " (by _%a_)"
deps: update dependency git-url-parse to v12 (978bf36) (by _Whitesource Renovate_)
lerna version --conventional-commits --changelog-include-commits-client-login " by %a (%e)" --remote-client github
deps: update dependency git-url-parse to v12 (978bf36) by _Whitesource Renovate (bot@renovateapp.com)
`> We recommend you first try it with the
option so that you can validate your remote client access and inspect the changelog output. Make sure to revert your changes once you're satisfied with the output.$3
Specify if we want to include commit remote client login (ie GitHub login username) to the end of each changelog commit entry and wrapped in
(@...). You could also provide a custom format by using any of these tokens (%l, %a, %e), see examples below.
- %l: remote client login, ie ("@renovate-bot")
- %a: git author name, ie: ("Whitesource Renovate")
- %e: git author email, ie: ("bot@renovateapp.com")> [!NOTE]
> If you're only interested in using
%a and %e, you should consider using --changelog-include-commits-git-author instead because --changelog-include-commits-client-login makes an API call to GitHub (via their GraphQL API) to fetch remote client logins. On the other hand, --changelog-include-commits-git-author simply reads your local Git and doesn't need any API fetching. So make sure to use the correct option depending on your use case.> [!NOTE]
> GitHub is the only supported client at the moment.
This option is only available when using
--conventional-commits with changelogs enabled. You must also provide 1 of these 2 options --create-release or --remote-client > Note this will execute one or more client remote API calls (GH is limited to 100 per query), which at the moment is only supporting the GitHub client type. This option will also require a valid
(or GITHUB_TOKEN) with read access permissions to the GitHub API so that it can execute the query to fetch all commit details since the last release, for more info refer to the Remote Client Auth Tokens below.> Note for this option to work properly, you must make sure that your local commits, on the current branch, are in sync with the remote server. It will then try to match all commits with their respective remote server commits and from there extract their associated remote client user login.
`sh
default format, without any argument
will add the remote client login name wrapped in (@...) and appended to the commit line entry
lerna version --conventional-commits --changelog-include-commits-client-login --create-release github
deps: update dependency git-url-parse to v12 (978bf36) (@renovate-bot)
custom format with 1 of these 3 tokens: %l, %a and/or %e ##
lerna version --conventional-commits --changelog-include-commits-client-login " by @%l" --remote-client github
deps: update dependency git-url-parse to v12 (978bf36) by @renovate-bot
lerna version --conventional-commits --changelog-include-commits-client-login " by @%l, %a (%e)" --remote-client github
deps: update dependency git-url-parse to v12 (978bf36) by @renovate-bot, _Whitesource Renovate (bot@renovateapp.com)
`> We recommend you first try it with the
option so that you can validate your remote client access and inspect the changelog output. Make sure to revert your changes once you're satisfied with the output.
$3
Add a custom message at the top of all "changelog.md" files. This option is only available when using
--conventional-commitssh
lerna version --conventional-commits --changelog-header-message "My Custom Header Message"
`$3
sh
lerna version --conventional-commits --conventional-prerelease --conventional-bump-prerelease
`When run with this flag,
will release with bumped prerelease versions even if already released packages are prereleases. Releases all unreleased changes as pre(patch/minor/major/release) by prefixing the version recommendation from conventional-commits with pre, eg. if present changes include a feature commit, the recommended bump will be minor, so this flag will result in a preminor release. If not used just a prerelease bump will be applied to prereleased packages.`sh
Changes:
- major: 1.0.0-alpha.0 => 2.0.0-alpha.0
- minor: 1.0.0-alpha.0 => 1.1.0-alpha.0
- patch: 1.0.0-alpha.0 => 1.0.1-alpha.0
`$3
sh
lerna version --conventional-commits --create-release github
lerna version --conventional-commits --create-release gitlab
`When run with this flag,
will create an official GitHub or GitLab release based on the changed packages. Requires --conventional-commits to be passed so that changelogs can be generated.> Note to avoid creating too many "Version bump only for package x" when using independent mode, you could enable the option
--skip-bump-only-releases$3
Create a discussion for this release, this will create both a Release and a Discussion. Conventional commits is required for this option to work.
sh
lerna version --conventional-commits --create-release github --create-release-discussion announcement
`> Note this option is currently only available for GitHub Releases following this GitHub blog post You can now link discussions to new releases
$3
When run with this flag,
will create an official GitHub release by automatically generating the name and body for the new release. Conventional commits is required for this option to work.`sh
lerna version --conventional-commits --create-release github --generate-release-notes
`Since GitHub automatically generates the name and body for the new release, you could skip the changelog creation if you wish.
sh
lerna version --conventional-commits --no-changelog --create-release github --generate-release-notes
`> Note this option is currently only available for GitHub Releases, more info can be found in this GitHub documentation page Automatically generated release notes
$3
When this option is enabled and a package version is only being bumped without any conventional commits detected, the GitHub/GitLab release will be skipped but only when using the independent mode. This will avoid creating releases with only "Version bump only for package x" in the release notes, however please note that each changelog are still going to be updated with the "version bump only" text.
sh
lerna version --create-release github --skip-bump-only-releasesor the same for gitlab
lerna version --create-release gitlab --skip-bump-only-releases
`> Note this option is only useful and can only be used with independent mode. Also please note that each changelogs are still going to be updated with the "version bump only" text and only the releases will be skipped.
$3
Add a custom header message to the top of the GitHub/GitLab Release body when using
. You can use the following tokens (%s: git tag, %v: version number only). This can be useful to add links to your website and/or show sponsors.`sh
lerna version --create-release github --release-header-message "### Visit our website for more details."
`Or via
:
`json
{
"command": {
"version": {
"releaseHeaderMessage": "### Visit our website for more details."
}
}
}
`> [!NOTE]
> The header/footer messages are only added to the GitHub/GitLab Releases, if you wish to add messages to your changelogs, then look take a look at
$3
Add a custom footer message to the bottom of the GitHub/GitLab Release body when using
. You can use the following tokens (%s: git tag, %v: version number only). This can be useful to add links to your website and/or show sponsors.`sh
lerna version --create-release github --release-footer-message "#### _🚀 Sponsored by XYZ_"
`Or via
:
`json
{
"command": {
"version": {
"releaseFooterMessage": "#### _🚀 Sponsored by XYZ_"
}
}
}
`$3
When is executed, it will identifies packages that have been updated since the previous tagged release. The rules it identifies are based on describe tag pattern (excuted git describe --match behind the scenes).The tag pattern defaults to
@ (independent mode) or "v*" (non-independent mode). You can configure describeTag in lerna.json to specify the tag pattern.The
describeTag will also take effect under lerna publish, for example lerna publish --canary, but it will not take effect under lerna publish from-git.`sh
lerna version --describe-tag "lerna-project"
`$3
##### GitHub Auth Token
To authenticate with GitHub, the following environment variables can be defined.-
or GITHUB_TOKEN: Your GitHub authentication token (under Settings > Developer settings > Personal access tokens), please give it the repo:public_repo scope when creating the token (for more info, refer to GitHub - Creating a personal access token).
- GHE_API_URL: When using GitHub Enterprise, an absolute URL to the API.
- GHE_VERSION: When using GitHub Enterprise, the currently installed GHE version. Supports the following versions.> Note even though
GH_TOKEN (or GITHUB_TOKEN) is the preferred way to automate the creation of a GitHub Release (especially in a CI environment), we are also providing a more manual mode when the GH_TOKEN could not be found or read. For that use case (when token cannot be read), we will create a link that once clicked it will open the GitHub web interface form with the fields pre-populated. This mode is enabled automatically when --create-release github is enabled without providing a valid GH_TOKEN environment variable.##### GitLab Auth Token
To authenticate with GitLab, the following environment variables can be defined.
-
GL_TOKEN (required): Your GitLab authentication token (under User Settings > Access Tokens).
- GL_API_URL: An absolute URL to the API, including the version. (Default: https://gitlab.com/api/v4)--no-changelog except when used with --generate-release-notes.$3
`sh
lerna version --exact
`When run with this flag,
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.
$3
`sh
lerna version --independent-subpackages
`If
, being a child of package A, has changes they will normally both get bumped although package A itself is eventually unchanged. If this flag is enabled and only package B was actually changed, package A will not get bumped if it does not have any changes on its own.$3
`sh
lerna version --force-publish=package-2,package-4force all packages to be versioned
lerna version --force-publish "*"Force all packages to a specific version (e.g., 1.0.1)
lerna version 1.0.1 --force-publish "*"
`When run with this flag,
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.
> NOTE: When used in combination with --conventional-commits and --conventional-graduate this option will be ignored.$3
Displays the git command that would be performed without actually executing it, however please note that it will still create all the changelogs. This could be helpful for troubleshooting and also to see changelog changes without committing them to Git.
> Note changelogs will still be created (when enabled) even in dry-run mode, so it could be useful to see what gets created without them being committed (however, make sure to revert the changes and roll back your version in
lerna.json once you're satisfied with the output).`sh
$ lerna version --dry-run
`$3
Allows users to specify a custom command to be used when applying git tags. For example, this may be useful for providing a wrapper command in CI/CD pipelines that have no direct write access.
sh
lerna version --git-tag-command "git gh-tag %s -m %s"
`This can also be configured in
.`json
{
"command": {
"version": {
"gitTagCommand": "git gh-tag %s -m %s"
}
}
}
`$3
Customize the tag version separator used when creating tags for independent versioning, defaults to "@".sh
lerna version --tag-version-separator "__"
`$3
sh
lerna version --git-remote upstream
`When run with this flag,
will push the git changes to the specified remote instead of origin.$3
Ignore changes in files matched by glob(s) when detecting changed packages.
`sh
lerna version --ignore-changes '/.md' '/__tests__/*'
`This option is best specified as root
configuration, both to avoid premature shell evaluation of the globs and to share the config with lerna diff and lerna changed:`json
{
"ignoreChanges": ["/__fixtures__/", "/__tests__/", "*/.md"]
}
`Pass
to disable any existing durable configuration.> In the following cases, a package will always be published, regardless of this option:
>
> 1. The latest release of the package is a
prerelease version (i.e. 1.0.0-alpha, 1.0.0–0.3.7, etc.).
> 2. One or more linked dependencies of the package have changed.$3
When passed, this flag will disable running lifecycle scripts during
lerna version.$3
`sh
lerna version --include-merged-tags
`Include tags from merged branches when detecting changed packages.
$3
This option is aliased to
for parity with git commit.`sh
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,
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 placeholder interpolation only applies when using the default "fixed" versioning mode, as there is no "global" version to interpolate when versioning independently.This can be configured in
lerna.json, as well:`json
{
"command": {
"version": {
"message": "chore(release): publish %s"
}
}
}
`$3
sh
lerna version --conventional-commits --no-changelog
`When using
, do not generate any CHANGELOG.md files.--create-release.$3
By default,
lerna version will allow git commit hooks to run when committing version changes.
Pass --no-commit-hooks to disable this behavior.This option is analogous to the
npm version option --commit-hooks, just inverted.$3
By default,
lerna version will commit changes to package.json files and tag the release.
Pass --no-git-tag-version to disable the behavior.This option is analogous to the
npm version option --git-tag-version, just inverted.$3
By default,
lerna version will git add _only_ the leaf package manifests (and possibly changelogs) that have changed during the versioning process. This yields the equivalent of git add -- packages/*/package.json, but tailored to _exactly_ what changed.If you know you need different behavior, you'll understand: Pass
--no-granular-pathspec to make the git command _literally_ git add -- .. By opting into this pathspec, you MUST HAVE _ALL_ SECRETS AND BUILD OUTPUT PROPERLY IGNORED, _OR IT WILL BE COMMITTED AND PUSHED_.This option makes the most sense configured in
lerna.json, as you really don't want to mess it up:`json
{
"version": "independent",
"granularPathspec": false
}
`The root-level configuration is intentional, as this also covers the identically-named option in
.$3
By default,
lerna version will include private packages when choosing versions, making commits, and tagging releases.
Pass --no-private to disable this behavior.Note that this option does _not_ exclude private scoped packages, only those with a
"private": true field in their package.json file.$3
By default,
lerna version will push the committed and tagged changes to the configured git remote.
Pass --no-push to disable this behavior.$3
When using pnpm or npm >= 7, the default config is to have Lerna-Lite update the npm
package-lock.json directly and even though that does work, it came with some drawback and you can now disable this option via this flag`sh
lerna version --no-manually-update-root-lockfile
`A newer and better option is to this use the new flag --sync-workspace-lock which will to rely on your package manager client to do the work (via
) which is a lot more reliable, future proof and requires a lot less code in Lerna-Lite itself.$3
This option allows arguments to be passed to the
npm install that lerna version performs to update the lockfile (when --sync-workspace-lock is enabled).For example:
`sh
lerna version 3.3.3 --sync-workspace-lock --npm-client-args=--legacy-peer-deps
lerna version 3.3.3 --sync-workspace-lock --npm-client-args="--legacy-peer-deps,--force"
lerna version 3.3.3 --sync-workspace-lock --npm-client-args="--legacy-peer-deps --force"
`This can also be set in
:`json
{
...
"npmClientArgs": ["--legacy-peer-deps", "--production"]
}
`or specifically for the version command:
json
{
...
"command": {
"version": {
"npmClientArgs": ["--legacy-peer-deps", "--production"]
}
}
}
`$3
sh
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,
will increment premajor, preminor, prepatch, or prerelease semver
bumps using the specified prerelease identifier.$3
This option allows you to control how lerna handles bumping versions for packages with a
premajor version (packages that have not had a major release, e.g. "version": "0.2.4")
when non-breaking changes are detected.
Breaking changes in premajor packages will always trigger a minor bump.`sh
lerna version --conventional-commits
OR
lerna version --conventional-commits --premajor-version-bump default
all non-breaking changes trigger a bump based on the configured conventional commits preset
for the default preset, a non-breaking feat would be a minor bump
0.1.0 --> 0.2.0
lerna version --conventional-commits --premajor-version-bump force-patch
ensures that all non-breaking premajor version bumps are handled as patches
in this case, a non-breaking feat would always be a patch bump
0.1.0 --> 0.1.1
`$3
This option will push all git tags one by one to overcome a GitHub limitation, which can happen when using
mode and too many tags are pushed at once.> Note please be aware that there is a performance impact to push each tag one at a time since this action is purposely limited to a concurrency of 1.
$3
Define which remote client type is used, this option can be used with [
--changelog-include-commits-client-login [msg]](#--changelog-include-commits-client-login-msg) and [publish --comment-issue [msg]](../publish/README.md#--comment-issue-msg) and [publish --comment-pull-request [msg]](../publish/README.md#--comment-pull-request-msg)`sh
lerna version --conventional-commits --remote-client github
lerna version --conventional-commits --remote-client gitlab
`For remote client authentication tokens, like
(or GITHUB_TOKEN), refer to Remote Client Auth Tokens$3
By default,
skips any lifecycle script when syncing the package-lock file after the version bump (when using NPM as npmClient).
With this option it will run prepare, postinstall, etc.$3
Adds the
--signoff flag to the git commit done by lerna version when executed.> Note This is different from
--sign-git-commit which is about gpg signatures.$3
This option is analogous to the
npm version option of the same name.$3
This option is analogous to the
npm version option of the same name.$3
This option replaces any existing tag instead of failing.
$3
This option allows to provide custom prefix instead of the default one:
v.Keep in mind that currently you have to supply it twice: for
version command and for publish command:`bash
locally
lerna version --tag-version-prefix=''
on ci
lerna publish from-git --tag-version-prefix=''
`$3
This flag will leverage your package manager client to update the project lock file (ie
) it relies heavily on the npmClient defined in your lerna.json config (pnpm, yarn or npm which is default) so make sure you have it configured correctly, this process will also include the lock file as part of your git change history once processed. This technique should be much more future proof and safer than having Lerna-Lite doing the actual work of updating the lock file which is not always ideal, neither safe, this flag is one of two solutions (the best option when available) to update the lock file. It might not be the best solution for your use case (ie it doesn't work with yarn classic), see all client notes below:#### Notes for each client:
>
pnpm/yarn users: we recommend using the workspace: protocol since it will prefer local dependencies and will make it less likely to fetch packages accidentally from the registry.>
yarn users: please note that this will only work with Yarn Berry 3.x and higher since it uses yarn install --mode update-lockfile (this will not work with yarn 1.x classic)`sh
lerna version --sync-workspace-lock
`Depending on the
defined, it will perform the following:`sh
npm is assuming a
package-lock.json lock file
npm install --package-lock-onlypnpm is assuming a "pnpm-lock.yaml" lock file and "npmClient": "pnpm"
pnpm install --lockfile-only --ignore-scriptsyarn is assuming a "yarn.lock" lock file and "npmClient": "yarn"
yarn install --mode update-lockfile
`$3
sh
lerna version --yes
skips
Are you sure you want to publish these packages?
When run with this flag,
will skip all confirmation prompts.
Useful in Continuous integration (CI) to automatically answer the publish confirmation prompt.Tips
$3
--conventional-commits option _after_ the monorepo has been active for awhile, you can still generate changelogs for previous releases using conventional-changelog-cli and lerna exec:`bash
Lerna does not actually use conventional-changelog-cli, so you need to install it temporarily
npm i -D conventional-changelog-cli
Documentation:
npx conventional-changelog --helpfixed versioning (default)
run in root, then leaves
npx conventional-changelog --preset angular --release-count 0 --outfile ./CHANGELOG.md --verbose
lerna exec --concurrency 1 --stream -- 'conventional-changelog --preset angular --release-count 0 --commit-path $PWD --pkg $PWD/package.json --outfile $PWD/CHANGELOG.md --verbose'independent versioning
(no root changelog)
lerna exec --concurrency 1 --stream -- 'conventional-changelog --preset angular --release-count 0 --commit-path $PWD --pkg $PWD/package.json --outfile $PWD/CHANGELOG.md --verbose --lerna-package $LERNA_PACKAGE_NAME'
, you should change --preset value accordingly in the example above.Lifecycle Scripts
`js
// preversion: Run BEFORE bumping the package version.
// version: Run AFTER bumping the package version, but BEFORE commit.
// postversion: Run AFTER bumping the package version, and AFTER commit.
`lerna will run npm lifecycle scripts during
in the following order:1. Detect changed packages, choose version bump(s)
2. Run
preversion lifecycle in root
3. For each changed package, in topological order (all dependencies before dependents):
1. Run preversion lifecycle
2. Update version in package.json
3. Run version lifecycle
4. Run version lifecycle in root
5. Add changed files to index, if enabled
6. Create commit and tag(s), if enabled
7. For each changed package, in _lexical_ order (alphabetical according to directory structure):
1. Run postversion lifecycle
8. Run postversion lifecycle in root
9. Push commit and tag(s) to remote, if enabled
10. Create release, if enabledcatalog: protocolThe
catalog: protocol (pnpm catalogs, Bun catalogs or Yarn catalogs) is also supported by Lerna-Lite, here's a quote from pnpm docs that best describes the feature.> "Catalogs" are a workspace feature for defining dependency version ranges as reusable constants. Constants defined in catalogs can later be referenced in
package.json files.Lerna-Lite will replace all
catalog: protocol with the version ranges from your global catalog(s), it wil search for them in your root config dependending on your package manager (e.g. npmClient: 'pnpm' => Catalogs located in pnpm-workspace.yaml, or for Bun which located in package.json > workspaces), then once it found all Catalog versions, it will execute the lerna version or publish commands.> [!NOTE]
> Lerna-Lite only has a read access to the catalog and will pull all dependency versions it finds from your config file catalog (e.g
pnpm-workspace.yaml), but it will never write back to that file. If for whatever reasons, you wish them to be bumped automatically, then we strongly suggest that you rather use the workspace: protocol instead of catalog which is better suited for local workspace dependencies. A side note though, it does work with local dependencies but only if the local dependency version changed in a previous git commit before lerna commands are executed (since again Lerna-Lite will never write or update any of the catalog dependencies).For more details about how Catalog works in Lerna-Lite, take a look at the
lerna publish#catalog documentation.workspace: protocolThe
workspace: protocol (pnpm workspace, yarn workspace) is also supported by Lerna-Lite. You could also use this in combo with the new --sync-workspace-lock flag to properly update your root project lock file. When versioning workspace: dependencies, it will do the following:- fixed target workspace will remain untouched (if you use
workspace:*, workspace:~, or workspace:^)
- semver range workspace will be bumped (if you use workspace:^1.2.3)So for example, if we have
foo, bar, qar, zoo in the workspace and they are all at version 1.5.0 and a minor bump is requested, then the following:`json
{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:~",
"qar": "workspace:^",
"zoo": "workspace:^1.5.0"
}
}
`Will apply the following updates to your
(assuming a minor version was requested):`json
{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:~",
"qar": "workspace:^",
"zoo": "workspace:^1.6.0"
}
}
`> Note semver range with an operator (ie