Skip to content

Commit 98cc35c

Browse files
committed
docs: change the text
1 parent fe5c3ad commit 98cc35c

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/cli/deploy.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ title: "pnpm deploy"
55

66
Deploy a package from a workspace. During deployment, the files of the deployed package are copied to the target directory. All dependencies of the deployed package, including dependencies from the workspace, are installed inside an isolated `node_modules` directory at the target directory. The target directory will contain a portable package that can be copied to a server and executed without additional steps.
77

8-
From pnpm v10.0.0 to v10.2.1, `deploy` requires the `injected-workspace-dependencies` setting to be set to `true`. From pnpm v10.2.1 onward, `injected-workspace-dependencies=true` is only required for lockfile deploy.
8+
:::note
9+
10+
By default, the deploy command only works with workspaces that have the `injected-workspace-dependencies` setting set to `true`. If you want to use deploy without "injected dependencies", use the `--legacy` flag or set `force-legacy-deploy` to `true`.
11+
12+
:::
913

1014
Usage:
1115

@@ -55,11 +59,11 @@ Packages in `devDependencies` won't be installed.
5559

5660
[Read more about filtering.](../filtering.md)
5761

58-
## --legacy
62+
### --legacy
5963

6064
Force legacy deploy implementation.
6165

62-
Since pnpm v10, by default, `pnpm deploy` will try creating a dedicated lockfile from a shared lockfile for deployment. The `--legacy` flag disables this behavior.
66+
Since pnpm v10, by default, `pnpm deploy` will try creating a dedicated lockfile from a shared lockfile for deployment. The `--legacy` flag disables this behavior and also allows using the deploy command without the `injected-workspace-dependencies=true` setting.
6367

6468
## Files included in the deployed project
6569

docs/npmrc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1026,7 +1026,7 @@ When set to `true`, installation will fail if the workspace has cycles.
10261026
* Default: **false**
10271027
* Type: **Boolean**
10281028

1029-
Since pnpm v10, by default, `pnpm deploy` will try creating a dedicated lockfile from a shared lockfile for deployment. If this setting is set to `true`, the legacy `deploy` behavior will be used.
1029+
By default, `pnpm deploy` will try creating a dedicated lockfile from a shared lockfile for deployment. If this setting is set to `true`, the legacy `deploy` behavior will be used.
10301030

10311031
## Other Settings
10321032

0 commit comments

Comments
 (0)