bugfix: ignore ranges when snapshot versioning is performed (use exact version)

.changeset/stupid-jars-rest.md

@@ -0,0 +1,5 @@
+---
+"@changesets/apply-release-plan": patch
+---
+
+bugfix: ignore ranges when snapshot versioning is performed (use exact version)

packages/apply-release-plan/src/index.test.ts

@@ -74,7 +74,11 @@ async function testSetup(
   fixtureName: string,
   releasePlan: ReleasePlan,
   config?: Config,
-  setupFunc?: (tempDir: string) => Promise<any>
+  setupFunc?: (tempDir: string) => Promise<any>,
+  snapshotConfig?: {
+    snapshot: string | undefined;
+    useCalculatedVersionForSnapshots: boolean;
+  }
 ) {
   if (!config) {
     config = {
@@ -89,7 +93,8 @@ async function testSetup(
       ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
         onlyUpdatePeerDependentsWhenOutOfRange: false,
         updateInternalDependents: "out-of-range",
-        useCalculatedVersionForSnapshots: false
+        useCalculatedVersionForSnapshots:
+          snapshotConfig?.useCalculatedVersionForSnapshots ?? false
       }
     };
   }
@@ -108,7 +113,8 @@ async function testSetup(
     changedFiles: await applyReleasePlan(
       releasePlan,
       await getPackages(tempDir),
-      config
+      config,
+      snapshotConfig?.snapshot
     ),
     tempDir
   };
@@ -653,6 +659,51 @@ describe("apply release plan", () => {
         version: "1.0.0"
       });
     });
+    it("should use exact versioning when snapshot release is applied, and ignore any range modifiers", async () => {
+      const releasePlan = new FakeReleasePlan(
+        [
+          {
+            id: "some-id",
+            releases: [{ name: "pkg-b", type: "minor" }],
+            summary: "a very useful summary"
+          }
+        ],
+        [
+          {
+            changesets: ["some-id"],
+            name: "pkg-b",
+            newVersion: "1.1.0",
+            oldVersion: "1.0.0",
+            type: "minor"
+          }
+        ]
+      );
+      let { changedFiles } = await testSetup(
+        "simple-project-caret-dep",
+        releasePlan.getReleasePlan(),
+        releasePlan.config,
+        undefined,
+        {
+          snapshot: "canary",
+          useCalculatedVersionForSnapshots: false
+        }
+      );
+
+      let pkgPath = changedFiles.find(a =>
+        a.endsWith(`pkg-a${path.sep}package.json`)
+      );
+
+      if (!pkgPath) throw new Error(`could not find an updated package json`);
+      let pkgJSON = await fs.readJSON(pkgPath);
+
+      expect(pkgJSON).toMatchObject({
+        name: "pkg-a",
+        version: "1.1.0",
+        dependencies: {
+          "pkg-b": "1.1.0"
+        }
+      });
+    });
 
     describe("internal dependency bumping", () => {
       describe("updateInternalDependencies set to patch", () => {

packages/apply-release-plan/src/index.ts

@@ -111,14 +111,19 @@ export default async function applyReleasePlan(
 
   // iterate over releases updating packages
   let finalisedRelease = releaseWithChangelogs.map(release => {
-    return versionPackage(release, versionsToUpdate, {
-      updateInternalDependencies: config.updateInternalDependencies,
-      onlyUpdatePeerDependentsWhenOutOfRange:
-        config.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
-          .onlyUpdatePeerDependentsWhenOutOfRange,
-      bumpVersionsWithWorkspaceProtocolOnly:
-        config.bumpVersionsWithWorkspaceProtocolOnly
-    });
+    return versionPackage(
+      release,
+      versionsToUpdate,
+      {
+        updateInternalDependencies: config.updateInternalDependencies,
+        onlyUpdatePeerDependentsWhenOutOfRange:
+          config.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
+            .onlyUpdatePeerDependentsWhenOutOfRange,
+        bumpVersionsWithWorkspaceProtocolOnly:
+          config.bumpVersionsWithWorkspaceProtocolOnly
+      },
+      snapshot
+    );
   });
 
   let prettierConfig = await prettier.resolveConfig(cwd);

packages/apply-release-plan/src/version-package.ts

@@ -29,7 +29,8 @@ export default function versionPackage(
     updateInternalDependencies: "patch" | "minor";
     onlyUpdatePeerDependentsWhenOutOfRange: boolean;
     bumpVersionsWithWorkspaceProtocolOnly?: boolean;
-  }
+  },
+  snapshot?: string | boolean | undefined
 ) {
   let { newVersion, packageJson } = release;
 
@@ -91,8 +92,9 @@ export default function versionPackage(
           // leaving those as is would leave the package in a non-installable state (wrong dep versions would get installed)
           semver.prerelease(version) !== null
         ) {
-          let rangeType = getVersionRangeType(depCurrentVersion);
-          let newNewRange = `${rangeType}${version}`;
+          let newNewRange = snapshot
+            ? version
+            : `${getVersionRangeType(depCurrentVersion)}${version}`;
           if (usesWorkspaceRange) newNewRange = `workspace:${newNewRange}`;
           deps[name] = newNewRange;
         }