lerna@lerna/publish
Publish packages in the current project
Install lerna for access to the lerna CLI.
Usage
lerna publish # publish packages that have changed since the last release
lerna publish from-git # explicitly publish packages tagged in the current commit
lerna publish from-package # explicitly publish packages where the latest version is not present in the registryWhen run, this command does one of the following things:
- Publish packages updated since the last release (calling
lerna versionbehind the scenes).- This is the legacy behavior of lerna 2.x
- Publish packages tagged in the current commit (
from-git). - Publish packages in the latest commit where the version is not present in the registry (
from-package). - Publish an unversioned "canary" release of packages (and their dependents) updated in the previous commit.
Lerna will never publish packages which are marked as private (
"private": truein thepackage.json).
During all publish operations, appropriate lifecycle scripts are called in the root and per-package (unless disabled by `--ignore-scripts).
Check out Per-Package Configuration for more details about publishing scoped packages, custom registries, and custom dist-tags.
Positionals
bump from-git
In addition to the semver keywords supported by lerna version,
lerna publish also supports the from-git keyword.
This will identify packages tagged by lerna version and publish them to npm.
This is useful in CI scenarios where you wish to manually increment versions,
but have the package contents themselves consistently published by an automated process.
bump from-package
Similar to the from-git keyword except the list of packages to publish is determined by inspecting each package.json
and determining if any package version is not present in the registry. Any versions not present in the registry will
be published.
This is useful when a previous lerna publish failed to publish all packages to the registry.
Options
lerna publish supports all of the options provided by lerna version in addition to the following:
--canary--contents <dir>--dist-tag <tag>--git-head <sha>--graph-type <all|dependencies>--ignore-scripts--ignore-prepublish--legacy-auth--no-git-reset--no-granular-pathspec--no-verify-access--otp--preid--pre-dist-tag <tag>--registry <url>--tag-version-prefix--temp-tag--yes
--canary
lerna publish --canary
# 1.0.0 => 1.0.1-alpha.0+${SHA} of packages changed since the previous commit
# a subsequent canary publish will yield 1.0.1-alpha.1+${SHA}, etc
lerna publish --canary --preid beta
# 1.0.0 => 1.0.1-beta.0+${SHA}
# The following are equivalent:
lerna publish --canary minor
lerna publish --canary preminor
# 1.0.0 => 1.1.0-alpha.0+${SHA}When run with this flag, lerna publish publishes packages in a more granular way (per commit).
Before publishing to npm, it creates the new version tag by taking the current version, bumping it to the next minor version, adding the provided meta suffix (defaults to alpha) and appending the current git sha (ex: 1.0.0 becomes 1.1.0-alpha.0+81e3b443).
If you have publish canary releases from multiple active development branches in CI,
it is recommended to customize the --preid and --dist-tag <tag> on a per-branch basis to avoid clashing versions.
The intended use case for this flag is a per commit level release or nightly release.
--contents <dir>
Subdirectory to publish. Must apply to ALL packages, and MUST contain a package.json file.
Package lifecycles will still be run in the original leaf directory.
You should probably use one of those lifecycles (prepare, prepublishOnly, or prepack) to create the subdirectory and whatnot.
If you're into unnecessarily complicated publishing, this will give you joy.
lerna publish --contents dist
# publish the "dist" subfolder of every Lerna-managed leaf packageNOTE: You should wait until the postpublish lifecycle phase (root or leaf) to clean up this generated subdirectory,
as the generated package.json is used during package upload (after postpack).
--dist-tag <tag>
lerna publish --dist-tag nextWhen run with this flag, lerna publish will publish to npm with the given npm dist-tag (defaults to latest).
This option can be used to publish a prerelease or beta version under a non-latest dist-tag, helping consumers avoid automatically upgrading to prerelease-quality code.
Note: the
latesttag is the one that is used when a user runsnpm install my-package. To install a different tag, a user can runnpm install my-package@prerelease.
--git-head <sha>
Explicit SHA to set as gitHead on manifests when packing tarballs, only allowed with from-package positional.
For example, when publishing from AWS CodeBuild (where git is not available),
you could use this option to pass the appropriate environment variable to use for this package metadata:
lerna publish from-package --git-head ${CODEBUILD_RESOLVED_SOURCE_VERSION}Under all other circumstances, this value is derived from a local git command.
--graph-type <all|dependencies>
Set which kind of dependencies to use when building a package graph. The default value is dependencies, whereby only packages listed in the dependencies section of a package's package.json are included. Pass all to include both dependencies and devDependencies when constructing the package graph and determining topological order.
When using traditional peer + dev dependency pairs, this option should be configured to all so the peers are always published before their dependents.
lerna publish --graph-type allConfigured via lerna.json:
{
"command": {
"publish": {
"graphType": "all"
}
}
}--ignore-scripts
When passed, this flag will disable running lifecycle scripts during lerna publish.
--ignore-prepublish
When passed, this flag will disable running deprecated prepublish scripts during lerna publish.
--legacy-auth
When publishing packages that require authentication but you are working with an internally hosted NPM Registry that only uses the legacy Base64 version of username:password. This is the same as the NPM publish _auth flag.
lerna publish --legacy-auth aGk6bW9t--no-git-reset
By default, lerna publish ensures any changes to the working tree have been reset.
To avoid this, pass --no-git-reset. This can be especially useful when used as part of a CI pipeline in conjunction with the --canary flag. For instance, the package.json version numbers which have been bumped may need to be used in subsequent CI pipeline steps (such as Docker builds).
lerna publish --no-git-reset--no-granular-pathspec
By default, lerna publish will attempt (if enabled) to git checkout only the leaf package manifests that are temporarily modified during the publishing process. This yields the equivalent of git checkout -- 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 checkout -- .. By opting into this pathspec, you must have all intentionally unversioned content properly ignored.
This option makes the most sense configured in lerna.json, as you really don't want to mess it up:
{
"version": "independent",
"granularPathspec": false
}The root-level configuration is intentional, as this also covers the identically-named option in lerna version.
--no-verify-access
By default, lerna will verify the logged-in npm user's access to the packages about to be published. Passing this flag will disable that check.
If you are using a third-party registry that does not support npm access ls-packages, you will need to pass this flag (or set command.publish.verifyAccess to false in lerna.json).
Please use with caution
--otp
When publishing packages that require two-factor authentication, you can specify a one-time password using --otp:
lerna publish --otp 123456Please keep in mind that one-time passwords expire within 30 seconds of their generation. If it expires during publish operations, a prompt will request a refreshed value before continuing.
--preid
Unlike the lerna version option of the same name, this option only applies to --canary version calculation.
lerna publish --canary
# uses the next semantic prerelease version, e.g.
# 1.0.0 => 1.0.1-alpha.0
lerna publish --canary --preid next
# uses the next semantic prerelease version with a specific prerelease identifier, e.g.
# 1.0.0 => 1.0.1-next.0When run with this flag, lerna publish --canary will increment premajor, preminor, prepatch, or prerelease semver
bumps using the specified prerelease identifier.
--pre-dist-tag <tag>
lerna publish --pre-dist-tag nextWorks the same as --dist-tag, except only applies to packages being released with a prerelease version.
--registry <url>
When run with this flag, forwarded npm commands will use the specified registry for your package(s).
This is useful if you do not want to explicitly set up your registry configuration in all of your package.json files individually when e.g. using private registries.
--tag-version-prefix
This option allows to provide custom prefix instead of the default one: v.
Keep in mind, if splitting lerna version and lerna publish, you need to pass it to both commands:
# locally
lerna version --tag-version-prefix=''
# on ci
lerna publish from-git --tag-version-prefix=''You could also configure this at the root level of lerna.json, applying to both commands equally:
{
"tagVersionPrefix": "",
"packages": ["packages/*"],
"version": "independent"
}--temp-tag
When passed, this flag will alter the default publish process by first publishing
all changed packages to a temporary dist-tag (lerna-temp) and then moving the
new version(s) to the dist-tag configured by --dist-tag (default latest).
This is not generally necessary, as Lerna will publish packages in topological order (all dependencies before dependents) by default.
--yes
lerna publish --canary --yes
# skips `Are you sure you want to publish the above changes?`When run with this flag, lerna publish will skip all confirmation prompts.
Useful in Continuous integration (CI) to automatically answer the publish confirmation prompt.
Deprecated Options
--skip-npm
Call lerna version directly, instead.
Per-Package Configuration
A leaf package can be configured with special publishConfig that in certain circumstances changes the behavior of lerna publish.
publishConfig.access
To publish packages with a scope (e.g., @mycompany/rocks), you must set access:
"publishConfig": {
"access": "public"
}- If this field is set for a package without a scope, it will fail.
If you want your scoped package to remain private (i.e.,
"restricted"), there is no need to set this value.Note that this is not the same as setting
"private": truein a leaf package; if theprivatefield is set, that package will never be published under any circumstances.
publishConfig.registry
You can customize the registry on a per-package basis by setting registry:
"publishConfig": {
"registry": "http://my-awesome-registry.com/"
}- Passing
--registryapplies globally, and in some cases isn't what you want.
publishConfig.tag
You can customize the dist-tag on a per-package basis by setting tag:
"publishConfig": {
"tag": "flippin-sweet"
}- Passing
--dist-tagwill overwrite this value. - This value is always ignored when
--canaryis passed.
publishConfig.directory
This non-standard field allows you to customize the published subdirectory just like --contents, but on a per-package basis. All other caveats of --contents still apply.
"publishConfig": {
"directory": "dist"
}Lifecycle Scripts
// prepublish: Run BEFORE the package is packed and published.
// prepare: Run BEFORE the package is packed and published, AFTER prepublish, BEFORE prepublishOnly.
// prepublishOnly: Run BEFORE the package is packed and published, ONLY on npm publish.
// prepack: Run BEFORE a tarball is packed.
// postpack: Run AFTER the tarball has been generated and moved to its final destination.
// publish: Run AFTER the package is published.
// postpublish: Run AFTER the package is published.Lerna will run npm lifecycle scripts during lerna publish in the following order:
- If versioning implicitly, run all version lifecycle scripts
- Run
prepublishlifecycle in root, if enabled - Run
preparelifecycle in root - Run
prepublishOnlylifecycle in root - Run
prepacklifecycle in root - For each changed package, in topological order (all dependencies before dependents):
- Run
postpacklifecycle in root - For each changed package, in topological order (all dependencies before dependents):
- Run
publishlifecycle in root- To avoid recursive calls, don't use this root lifecycle to run
lerna publish
- To avoid recursive calls, don't use this root lifecycle to run
- Run
postpublishlifecycle in root - Update temporary dist-tag to latest, if enabled