fix(deploy): don't modify the lockfile and fail in CI

close #5071
pnpm · Jul 21, 2022 · 3839144 · 3839144
1 parent 7334b34
commit 3839144
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 1 deletion.
diff --git a/.changeset/clever-guests-heal.md b/.changeset/clever-guests-heal.md
@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-deploy": patch
+"pnpm": patch
+---
+
+`pnpm deploy` should not modify the lockfile [#5071](https://github.com/pnpm/pnpm/issues/5071)
diff --git a/.changeset/clever-guests-heal2.md b/.changeset/clever-guests-heal2.md
@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-deploy": patch
+"pnpm": patch
+---
+
+`pnpm deploy` should not fail in CI [#5071](https://github.com/pnpm/pnpm/issues/5071)
diff --git a/.changeset/wise-guests-turn.md b/.changeset/wise-guests-turn.md
@@ -0,0 +1,6 @@
+---
+"@pnpm/core": minor
+"@pnpm/plugin-commands-installation": minor
+---
+
+When `saveLockfile` is set to `false`, no changes to `pnpm-lock.yaml` are written to the filesystem.
diff --git a/packages/core/src/install/extendInstallOptions.ts b/packages/core/src/install/extendInstallOptions.ts
@@ -25,6 +25,7 @@ export interface StrictInstallOptions {
   extraBinPaths: string[]
   hoistingLimits?: HoistingLimits
   useLockfile: boolean
+  saveLockfile: boolean
   useGitBranchLockfile: boolean
   mergeGitBranchLockfiles: boolean
   linkWorkspacePackagesDepth: number
@@ -173,6 +174,7 @@ const defaults = async (opts: InstallOptions) => {
       process.getuid() !== 0,
     update: false,
     useLockfile: true,
+    saveLockfile: true,
     useGitBranchLockfile: false,
     mergeGitBranchLockfiles: false,
     userAgent: `${packageManager.name}/${packageManager.version} npm/? node/${process.version} ${process.platform} ${process.arch}`,

diff --git a/packages/core/src/install/index.ts b/packages/core/src/install/index.ts
@@ -1028,7 +1028,7 @@ const _installInContext: InstallFunction = async (projects, ctx, opts) => {
 
     const projectsWithTargetDirs = extendProjectsWithTargetDirs(projects, newLockfile, ctx)
     await Promise.all([
-      opts.useLockfile
+      opts.useLockfile && opts.saveLockfile
         ? writeLockfiles({
           currentLockfile: result.currentLockfile,
           currentLockfileDir: ctx.virtualStoreDir,

diff --git a/packages/plugin-commands-deploy/src/deploy.ts b/packages/plugin-commands-deploy/src/deploy.ts
@@ -83,8 +83,14 @@ export async function handler (
     },
     frozenLockfile: false,
     preferFrozenLockfile: false,
+    saveLockfile: false,
     virtualStoreDir: path.join(deployDir, 'node_modules/.pnpm'),
     modulesDir: path.relative(deployedDir, path.join(deployDir, 'node_modules')),
+    rawLocalConfig: {
+      ...opts.rawLocalConfig,
+      // This is a workaround to prevent frozen install in CI envs.
+      'frozen-lockfile': false,
+    },
   })
 }
 

diff --git a/packages/plugin-commands-deploy/test/deploy.test.ts b/packages/plugin-commands-deploy/test/deploy.test.ts
@@ -52,6 +52,8 @@ test('deploy', async () => {
     production: true,
     recursive: true,
     selectedProjectsGraph,
+    sharedWorkspaceLockfile: true,
+    lockfileDir: process.cwd(),
     workspaceDir: process.cwd(),
   }, ['deploy'])
 
@@ -62,4 +64,5 @@ test('deploy', async () => {
   await project.hasNot('is-negative')
   expect(fs.existsSync('deploy/index.js')).toBeTruthy()
   expect(fs.existsSync('deploy/test.js')).toBeFalsy()
+  expect(fs.existsSync('pnpm-lock.yaml')).toBeFalsy() // no changes to the lockfile are written
 })
diff --git a/packages/plugin-commands-installation/src/install.ts b/packages/plugin-commands-installation/src/install.ts
@@ -288,6 +288,7 @@ export type InstallCommandOptions = Pick<Config,
   pruneDirectDependencies?: boolean
   pruneStore?: boolean
   recursive?: boolean
+  saveLockfile?: boolean
   workspace?: boolean
 } & Partial<Pick<Config, 'modulesCacheMaxAge' | 'pnpmHomeDir' | 'preferWorkspacePackages'>>