Skip to content

Commit 9a233ae

Browse files
author
LAN Xingcan
committed
Add a new bump strategy for peers bump, resolve changesets#1011, changesets#960, changesets#822
1 parent 7323704 commit 9a233ae

7 files changed

Lines changed: 166 additions & 14 deletions

File tree

‎.changeset/short-geese-taste.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
"@changesets/assemble-release-plan": minor
3+
"@changesets/config": minor
4+
"@changesets/types": minor
5+
---
6+
7+
Add a new bump strategy for peers bump.
8+
9+
This adds a new option "updatePeersDependencies" to the config, and can be set
10+
to "major" (default) or "follow". When set to "major", it preserves the
11+
origin behaviour that when peers dependencies has a minor or major bump,
12+
the dependent need to perform a major bump; when set to "follow", when peers
13+
have a major/minor/patch bump, the dependent will need to perform **at least**
14+
a major/minor/patch bump, respectively.

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

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,19 +74,55 @@ export default function determineDependents({
7474
if (nextRelease.type === "none") {
7575
continue;
7676
} else if (
77-
shouldBumpMajor({
78-
dependent,
77+
shouldBumpsForPeerDeps({
7978
depType,
8079
versionRange,
81-
releases,
8280
nextRelease,
8381
preInfo,
8482
onlyUpdatePeerDependentsWhenOutOfRange:
8583
config.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
8684
.onlyUpdatePeerDependentsWhenOutOfRange,
8785
})
8886
) {
89-
type = "major";
87+
if (config.updatePeerDependencies === "major") {
88+
if (nextRelease.type === "patch") {
89+
if (
90+
!semverSatisfies(
91+
incrementVersion(nextRelease, preInfo),
92+
versionRange
93+
)
94+
) {
95+
type = "patch";
96+
}
97+
}
98+
// bump major only if the dependent doesn't already have a major release.
99+
else if (
100+
!releases.has(dependent) ||
101+
(releases.has(dependent) &&
102+
releases.get(dependent)!.type !== "major")
103+
)
104+
type = "major";
105+
} else {
106+
if (!releases.has(dependent)) {
107+
type = nextRelease.type;
108+
} else {
109+
switch (releases.get(dependent)!.type) {
110+
case "none":
111+
type = nextRelease.type;
112+
break;
113+
case "patch":
114+
if (nextRelease.type !== "patch") {
115+
type = nextRelease.type;
116+
}
117+
break;
118+
case "minor":
119+
if (nextRelease.type === "major") {
120+
type = nextRelease.type;
121+
}
122+
break;
123+
}
124+
}
125+
}
90126
} else if (
91127
(!releases.has(dependent) ||
92128
releases.get(dependent)!.type === "none") &&
@@ -212,19 +248,15 @@ function getDependencyVersionRanges(
212248
return dependencyVersionRanges;
213249
}
214250

215-
function shouldBumpMajor({
216-
dependent,
251+
function shouldBumpsForPeerDeps({
217252
depType,
218253
versionRange,
219-
releases,
220254
nextRelease,
221255
preInfo,
222256
onlyUpdatePeerDependentsWhenOutOfRange,
223257
}: {
224-
dependent: string;
225258
depType: DependencyType;
226259
versionRange: string;
227-
releases: Map<string, InternalRelease>;
228260
nextRelease: InternalRelease;
229261
preInfo: PreInfo | undefined;
230262
onlyUpdatePeerDependentsWhenOutOfRange: boolean;
@@ -233,13 +265,9 @@ function shouldBumpMajor({
233265
return (
234266
depType === "peerDependencies" &&
235267
nextRelease.type !== "none" &&
236-
nextRelease.type !== "patch" &&
237268
// 1. If onlyUpdatePeerDependentsWhenOutOfRange set to true, bump major if the version is leaving the range.
238269
// 2. If onlyUpdatePeerDependentsWhenOutOfRange set to false, bump major regardless whether or not the version is leaving the range.
239270
(!onlyUpdatePeerDependentsWhenOutOfRange ||
240-
!semverSatisfies(incrementVersion(nextRelease, preInfo), versionRange)) &&
241-
// bump major only if the dependent doesn't already has a major release.
242-
(!releases.has(dependent) ||
243-
(releases.has(dependent) && releases.get(dependent)!.type !== "major"))
271+
!semverSatisfies(incrementVersion(nextRelease, preInfo), versionRange))
244272
);
245273
}

‎packages/assemble-release-plan/src/index.test.ts‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1401,6 +1401,70 @@ describe("bumping peerDeps", () => {
14011401
expect(releases[1].name).toEqual("pkg-b");
14021402
expect(releases[1].newVersion).toEqual("2.0.0");
14031403
});
1404+
1405+
it("should major bump dependent when bumping caret peerDep by major when updatePeerDependencies = follow", () => {
1406+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1407+
setup.addChangeset({
1408+
id: "anyway-the-windblows",
1409+
releases: [{ name: "pkg-a", type: "major" }],
1410+
});
1411+
1412+
let { releases } = assembleReleasePlan(
1413+
setup.changesets,
1414+
setup.packages,
1415+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1416+
undefined
1417+
);
1418+
1419+
expect(releases.length).toBe(2);
1420+
expect(releases[0].name).toEqual("pkg-a");
1421+
expect(releases[0].newVersion).toEqual("2.0.0");
1422+
expect(releases[1].name).toEqual("pkg-b");
1423+
expect(releases[1].newVersion).toEqual("2.0.0");
1424+
});
1425+
1426+
it("should minor bump dependent when bumping caret peerDep by minor when updatePeerDependencies = follow", () => {
1427+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1428+
setup.addChangeset({
1429+
id: "anyway-the-windblows",
1430+
releases: [{ name: "pkg-a", type: "minor" }],
1431+
});
1432+
1433+
let { releases } = assembleReleasePlan(
1434+
setup.changesets,
1435+
setup.packages,
1436+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1437+
undefined
1438+
);
1439+
1440+
expect(releases.length).toBe(2);
1441+
expect(releases[0].name).toEqual("pkg-a");
1442+
expect(releases[0].newVersion).toEqual("1.1.0");
1443+
expect(releases[1].name).toEqual("pkg-b");
1444+
expect(releases[1].newVersion).toEqual("1.1.0");
1445+
});
1446+
1447+
it("should patch bump dependent when bumping caret peerDep by patch when updatePeerDependencies = follow", () => {
1448+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1449+
setup.addChangeset({
1450+
id: "anyway-the-windblows",
1451+
releases: [{ name: "pkg-a", type: "patch" }],
1452+
});
1453+
1454+
let { releases } = assembleReleasePlan(
1455+
setup.changesets,
1456+
setup.packages,
1457+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1458+
undefined
1459+
);
1460+
1461+
expect(releases.length).toBe(2);
1462+
expect(releases[0].name).toEqual("pkg-a");
1463+
expect(releases[0].newVersion).toEqual("1.0.1");
1464+
expect(releases[1].name).toEqual("pkg-b");
1465+
expect(releases[1].newVersion).toEqual("1.0.1");
1466+
});
1467+
14041468
it("should patch bump transitive dep that is only affected by peerDep bump", () => {
14051469
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
14061470
setup.addPackage("pkg-c", "1.0.0");

‎packages/config/schema.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,11 @@
122122
"description": "The minimum bump type to trigger automatic update of internal dependencies that are part of the same release.",
123123
"default": "patch"
124124
},
125+
"updatePeerDependencies": {
126+
"enum": ["major", "follow"],
127+
"type": "string",
128+
"description": "The strategy used to trigger automatic update of peer dependencies that are part of the same release, \"follow\" means if peer dependencies has a major/minor/patch bumps, this package will have a major/minor/patch bump too, respectively"
129+
},
125130
"bumpVersionsWithWorkspaceProtocolOnly": {
126131
"type": "boolean",
127132
"default": false,

‎packages/config/src/index.test.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ test("read reads the config", async () => {
4848
baseBranch: "master",
4949
changedFilePatterns: ["**"],
5050
updateInternalDependencies: "patch",
51+
updatePeerDependencies: "major",
5152
ignore: [],
5253
bumpVersionsWithWorkspaceProtocolOnly: false,
5354
privatePackages: {
@@ -106,6 +107,7 @@ let defaults: Config = {
106107
baseBranch: "master",
107108
changedFilePatterns: ["**"],
108109
updateInternalDependencies: "patch",
110+
updatePeerDependencies: "major",
109111
ignore: [],
110112
privatePackages: { version: true, tag: false },
111113
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
@@ -309,6 +311,24 @@ let correctCases: Record<string, CorrectCase> = {
309311
updateInternalDependencies: "patch",
310312
},
311313
},
314+
"update peer dependencies major": {
315+
input: {
316+
updatePeerDependencies: "major",
317+
},
318+
output: {
319+
...defaults,
320+
updatePeerDependencies: "major",
321+
},
322+
},
323+
"update peer dependencies follow": {
324+
input: {
325+
updatePeerDependencies: "follow",
326+
},
327+
output: {
328+
...defaults,
329+
updatePeerDependencies: "follow",
330+
},
331+
},
312332
ignore: {
313333
input: {
314334
ignore: ["pkg-a", "pkg-b"],

‎packages/config/src/index.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export let defaultWrittenConfig = {
2323
access: "restricted",
2424
baseBranch: "master",
2525
updateInternalDependencies: "patch",
26+
updatePeerDepeendencies: "major",
2627
ignore: [] as ReadonlyArray<string>,
2728
} as const;
2829

@@ -293,6 +294,20 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {
293294
)} but can only be 'patch' or 'minor'`
294295
);
295296
}
297+
298+
if (
299+
json.updatePeerDependencies !== undefined &&
300+
!["major", "follow"].includes(json.updatePeerDependencies)
301+
) {
302+
messages.push(
303+
`The \`updatePeerDependences\` option is set as ${JSON.stringify(
304+
json.updatePeerDependencies,
305+
null,
306+
2
307+
)} but can only be 'major' or 'follow'`
308+
);
309+
}
310+
296311
if (json.ignore) {
297312
if (
298313
!(
@@ -445,6 +460,10 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {
445460
? defaultWrittenConfig.updateInternalDependencies
446461
: json.updateInternalDependencies,
447462

463+
updatePeerDependencies:
464+
json.updatePeerDependencies === undefined
465+
? defaultWrittenConfig.updatePeerDepeendencies
466+
: json.updatePeerDependencies,
448467
ignore:
449468
json.ignore === undefined
450469
? defaultWrittenConfig.ignore

‎packages/types/src/index.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export type Config = {
7878
privatePackages: PrivatePackages;
7979
/** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
8080
updateInternalDependencies: "patch" | "minor";
81+
updatePeerDependencies: "major" | "follow";
8182
ignore: ReadonlyArray<string>;
8283
/** This is supposed to be used with pnpm's `link-workspace-packages: false` and Berry's `enableTransparentWorkspaces: false` */
8384
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
@@ -108,6 +109,7 @@ export type WrittenConfig = {
108109
};
109110
/** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
110111
updateInternalDependencies?: "patch" | "minor";
112+
updatePeerDependencies?: "major" | "follow";
111113
ignore?: ReadonlyArray<string>;
112114
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
113115
snapshot?: {

0 commit comments

Comments
 (0)