Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(deploy): flag and setting for legacy #635

Merged
merged 6 commits into from
Feb 6, 2025
Merged

docs(deploy): flag and setting for legacy #635

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
271bf12
docs(deploy): flag and setting for legacy
KSXGitHub Feb 6, 2025
925c72d
docs: reduce diff noise
KSXGitHub Feb 6, 2025
c817778
docs: mention `injected-workspace-dependencies`
KSXGitHub Feb 6, 2025
fe5c3ad
docs: fix
KSXGitHub Feb 6, 2025
98cc35c
docs: change the text
zkochan Feb 6, 2025
61336ac
docs: change the text
zkochan Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/cli/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ Packages in `devDependencies` won't be installed.

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

## --legacy

Force legacy deploy implementation.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also mention the injected dependencies setting that is required in v10

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

c817778 has added mention of this setting.

I added it to near top instead of --legacy because this setting is required by both legacy and the new implementation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand. Isn't legacy the algorithm from pnpm v9, which didn't require injected deps?

## Files included in the deployed project

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:
Expand Down
9 changes: 9 additions & 0 deletions docs/npmrc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,6 +1019,15 @@ When set to `true`, no workspace cycle warnings will be printed.

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

## Deploy Settings

### force-legacy-deploy

* Default: **false**
* Type: **Boolean**

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.

## Other Settings

### save-prefix
Expand Down
Loading