Adhere to semver rules when using workspace:^ dependencies, fixes #1290

.changeset/clever-candles-obey.md

@@ -0,0 +1,14 @@
+---
+"@changesets/assemble-release-plan": major
+"@changesets/cli": major
+"@changesets/get-release-plan": major
+---
+
+Use semver compat for workspace:^ and workspace:~ dependencies.
+
+Prior to this change, all packages depending on an updated package via `workspace:^` or `workspace:~` got a version bump.
+This leads to packages being released that don't need to be according to semver.
+
+This is a bugfix in terms of supporting semver, but it's breaking backwards compatible behavior.
+
+If you're using `workspace:^` or `workspace:~` dependencies in your project, ensure that changes to dependencies of a package come with a dedicated changeset for that package.

packages/assemble-release-plan/src/determine-dependents.ts

@@ -186,15 +186,23 @@ function getDependencyVersionRanges(
     if (!versionRange) continue;
 
     if (versionRange.startsWith("workspace:")) {
+      // intentionally keep other workspace ranges untouched
+      // this has to be fixed but this should only be done when adding appropriate tests
+      let workspaceRange = versionRange.replace(/^workspace:/, "");
+      switch (workspaceRange) {
+        case "*":
+          // workspace:* actually means the current exact version, and not a wildcard similar to a reguler * range
+          workspaceRange = dependencyRelease.oldVersion;
+          break;
+        case "~":
+        case "^":
+          // Use ^oldVersion for workspace:^ or ~oldVersion for workspace:~.
+          // The version range might have changed in dependent package, but that should have its own changeset bumping that package.
+          workspaceRange += dependencyRelease.oldVersion;
+      }
       dependencyVersionRanges.push({
         depType: type,
-        versionRange:
-          // intentionally keep other workspace ranges untouched
-          // this has to be fixed but this should only be done when adding appropriate tests
-          versionRange === "workspace:*"
-            ? // workspace:* actually means the current exact version, and not a wildcard similar to a reguler * range
-              dependencyRelease.oldVersion
-            : versionRange.replace(/^workspace:/, ""),
+        versionRange: workspaceRange,
       });
     } else {
       dependencyVersionRanges.push({

packages/cli/src/commands/version/version.test.ts

@@ -1038,7 +1038,7 @@ describe("workspace range", () => {
     ]);
   });
 
-  it("should bump dependent package when bumping a `workspace:^` dependency", async () => {
+  it("should not bump dependent package with a patch release for a `workspace:^` dependency", async () => {
     const cwd = await testdir({
       "package.json": JSON.stringify({
         private: true,
@@ -1070,14 +1070,102 @@ describe("workspace range", () => {
     expect(packages.packages.map((x) => x.packageJson)).toEqual([
       {
         name: "pkg-a",
+        version: "1.0.0",
+        dependencies: {
+          "pkg-b": "workspace:^",
+        },
+      },
+      {
+        name: "pkg-b",
         version: "1.0.1",
+      },
+    ]);
+  });
+
+  it("should not bump dependent package with a minor release for a `workspace:^` dependency", async () => {
+    const cwd = await testdir({
+      "package.json": JSON.stringify({
+        private: true,
+        workspaces: ["packages/*"],
+      }),
+      "packages/pkg-a/package.json": JSON.stringify({
+        name: "pkg-a",
+        version: "1.0.0",
+        dependencies: {
+          "pkg-b": "workspace:^",
+        },
+      }),
+      "packages/pkg-b/package.json": JSON.stringify({
+        name: "pkg-b",
+        version: "1.0.0",
+      }),
+    });
+
+    await writeChangeset(
+      {
+        releases: [{ name: "pkg-b", type: "minor" }],
+        summary: "a very useful summary for the change",
+      },
+      cwd
+    );
+    await version(cwd, defaultOptions, modifiedDefaultConfig);
+
+    let packages = await getPackages(cwd);
+    expect(packages.packages.map((x) => x.packageJson)).toEqual([
+      {
+        name: "pkg-a",
+        version: "1.0.0",
         dependencies: {
           "pkg-b": "workspace:^",
         },
       },
       {
         name: "pkg-b",
+        version: "1.1.0",
+      },
+    ]);
+  });
+
+  it("should bump dependent package with a major release for a `workspace:^` dependency", async () => {
+    const cwd = await testdir({
+      "package.json": JSON.stringify({
+        private: true,
+        workspaces: ["packages/*"],
+      }),
+      "packages/pkg-a/package.json": JSON.stringify({
+        name: "pkg-a",
+        version: "1.0.0",
+        dependencies: {
+          "pkg-b": "workspace:^",
+        },
+      }),
+      "packages/pkg-b/package.json": JSON.stringify({
+        name: "pkg-b",
+        version: "1.0.0",
+      }),
+    });
+
+    await writeChangeset(
+      {
+        releases: [{ name: "pkg-b", type: "major" }],
+        summary: "a very useful summary for the change",
+      },
+      cwd
+    );
+    await version(cwd, defaultOptions, modifiedDefaultConfig);
+
+    let packages = await getPackages(cwd);
+    expect(packages.packages.map((x) => x.packageJson)).toEqual([
+      {
+        name: "pkg-a",
         version: "1.0.1",
+        dependencies: {
+          "pkg-b": "workspace:^",
+        },
+      },
+      {
+        name: "pkg-b",
+        version: "2.0.0",
       },
     ]);
   });