feat(install): add --frozen-lockfile flag for CI environments - #10239
Open
zubeyralmaho wants to merge 3 commits into
Open
feat(install): add --frozen-lockfile flag for CI environments#10239zubeyralmaho wants to merge 3 commits into
zubeyralmaho wants to merge 3 commits into
Conversation
Add support for --frozen-lockfile option to the `bit install` command. When enabled, installation will fail if the lockfile needs to be updated, ensuring reproducible builds in CI environments. The flag flows through: - CLI (install.cmd.tsx) - WorkspaceInstallOptions (install.main.runtime.ts) - PackageManagerInstallOptions (package-manager.ts) - pnpm integration (pnpm.package-manager.ts, lynx.ts) Includes E2E tests verifying both success and failure scenarios. Closes teambit#5093 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for a --frozen-lockfile option to bit install, intended for CI usage to ensure installs don’t proceed when the lockfile would need changes.
Changes:
- Introduce
frozenLockfile?: booleanthroughInstallCmdOptions→WorkspaceInstallOptions→PackageManagerInstallOptions. - Wire the new option into the pnpm installer integration (
lynx/pnpm.package-manager). - Add E2E coverage for success/failure behavior when using pnpm.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scopes/workspace/install/install.main.runtime.ts | Plumbs frozenLockfile from workspace install options into package-manager install options. |
| scopes/workspace/install/install.cmd.tsx | Adds --frozen-lockfile CLI flag and forwards it into WorkspaceInstallOptions. |
| scopes/dependencies/dependency-resolver/package-manager.ts | Extends PackageManagerInstallOptions with frozenLockfile (with documentation). |
| scopes/dependencies/pnpm/pnpm.package-manager.ts | Passes frozenLockfile into pnpm install execution options. |
| scopes/dependencies/pnpm/lynx.ts | Adds frozenLockfile to pnpm core InstallOptions used by mutateModules. |
| e2e/harmony/install.e2e.ts | Adds E2E tests for --frozen-lockfile success and failure scenarios (pnpm). |
You can also share your feedback on Copilot code review. Take the survey.
| ], | ||
| ['', 'no-optional [noOptional]', 'do not install optional dependencies (works with pnpm only)'], | ||
| ['', 'lockfile-only', 'dependencies are not written to node_modules. Only the lockfile is updated'], | ||
| ['', 'frozen-lockfile', 'fail if the lockfile needs to be updated (useful for CI environments)'], |
Member
There was a problem hiding this comment.
@zubeyralmaho yarn supports this flag as well. So, maybe let's pass it to yarn too.
Author
There was a problem hiding this comment.
@zkochan Done! Added immutable option to Yarn's project.install() call, which is Yarn Berry's equivalent of --frozen-lockfile. Also skipped persistLockfile() when the flag is active.
Member
|
Thanks for your contribution. I'll review the changes. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a --frozen-lockfile option to bit install intended for CI/reproducible installs by failing when the lockfile would need changes, and wires it through the install option layers into pnpm.
Changes:
- Expose
--frozen-lockfileon thebit installCLI and propagate it throughWorkspaceInstallOptions→PackageManagerInstallOptions. - Pass the new option into the pnpm installer (via
PnpmPackageManager→lynx.install). - Add E2E coverage for success (up-to-date lockfile) and failure (lockfile drift) scenarios.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scopes/workspace/install/install.main.runtime.ts | Extends workspace install options and forwards frozenLockfile into package-manager install options. |
| scopes/workspace/install/install.cmd.tsx | Adds the --frozen-lockfile CLI flag and passes it into InstallMain.install() options. |
| scopes/dependencies/dependency-resolver/package-manager.ts | Extends PackageManagerInstallOptions with documented frozenLockfile. |
| scopes/dependencies/pnpm/pnpm.package-manager.ts | Forwards frozenLockfile into pnpm install call options. |
| scopes/dependencies/pnpm/lynx.ts | Plumbs frozenLockfile into pnpm core InstallOptions. |
| e2e/harmony/install.e2e.ts | Adds E2E tests for --frozen-lockfile behavior (pnpm path). |
You can also share your feedback on Copilot code review. Take the survey.
| ], | ||
| ['', 'no-optional [noOptional]', 'do not install optional dependencies (works with pnpm only)'], | ||
| ['', 'lockfile-only', 'dependencies are not written to node_modules. Only the lockfile is updated'], | ||
| ['', 'frozen-lockfile', 'fail if the lockfile needs to be updated (useful for CI environments)'], |
| }); | ||
| }); | ||
| }); | ||
|
|
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--frozen-lockfileflag to thebit installcommandChanges
The flag flows through multiple layers:
install.cmd.tsxWorkspaceInstallOptionsininstall.main.runtime.tsPackageManagerInstallOptionsinpackage-manager.tspnpm.package-manager.tsandlynx.tsTest plan
bit install --frozen-lockfilesucceeds when lockfile is up to datebit install --frozen-lockfilefails with clear error when lockfile needs updateCloses #5093