Skip to content

Commit ca63dde

Browse files
KSXGitHubzkochan
andauthored
docs(deploy): flag and setting for legacy (#635)
* docs(deploy): flag and setting for legacy * docs: reduce diff noise * docs: mention `injected-workspace-dependencies` * docs: fix * docs: change the text * docs: change the text --------- Co-authored-by: Zoltan Kochan <z@kochan.io>
1 parent 589cc9d commit ca63dde

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/cli/deploy.md

+12
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ 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+
:::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+
:::
13+
814
Usage:
915

1016
```
@@ -53,6 +59,12 @@ Packages in `devDependencies` won't be installed.
5359

5460
[Read more about filtering.](../filtering.md)
5561

62+
### --legacy
63+
64+
Force legacy deploy implementation.
65+
66+
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.
67+
5668
## Files included in the deployed project
5769

5870
By default, all the files of the project are copied during deployment but this can be modified in _one_ of the following ways which are resolved in order:

docs/npmrc.md

+9
Original file line numberDiff line numberDiff line change
@@ -1019,6 +1019,15 @@ When set to `true`, no workspace cycle warnings will be printed.
10191019

10201020
When set to `true`, installation will fail if the workspace has cycles.
10211021

1022+
## Deploy Settings
1023+
1024+
### force-legacy-deploy
1025+
1026+
* Default: **false**
1027+
* Type: **Boolean**
1028+
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.
1030+
10221031
## Other Settings
10231032

10241033
### save-prefix

0 commit comments

Comments
 (0)